292 Commits

Author	SHA1	Message	Date
Keewis	530793d997	update the link to the official docstring guide	2020-07-25 11:37:32 +02:00
Hameer Abbasi	a4413810bc	Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3	2020-07-24 17:01:39 +02:00
Hameer Abbasi	8f5ce152a1	Fold line.	2020-07-24 16:59:40 +02:00
Hameer Abbasi	98d3ed01ff	Merge branch 'master' into mathjax-3	2020-07-24 16:58:55 +02:00
Hameer Abbasi	496ac3fe8b	Change MathJax 2 path string. ... Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>	2020-07-24 12:31:23 +02:00
Hameer Abbasi	aed8f719ca	Expand warning and refer to it from CHANGES.	2020-07-24 11:52:30 +02:00
Takeshi KOMIYA	da174138af	Merge pull request #7927 from jnothman/name-case-clash ... Add autosummary_filename_map config to avoid clashes	2020-07-24 01:07:19 +09:00
Hameer Abbasi	72f3592796	Delete repeated word. ... Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>	2020-07-15 14:39:56 +02:00
Hameer Abbasi	436519743b	Move to MathJax 3.	2020-07-15 13:09:08 +02:00
Johannes Lade	91285f39a6	Update description of autosummary_generate_overwrite ... The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.	2020-07-13 14:03:06 +02:00
Joel Nothman	72ca2bdffc	Add autosummary_filename_map config to avoid clashes	2020-07-08 16:51:57 +10:00
Nguyễn Gia Phong	1a865069db	napoleon: Add aliases Warn and Raise	2020-06-29 22:19:54 +07:00
Takeshi KOMIYA	42f29b6acf	doc: Add modname separator tip for autodoc (refs: #7841)	2020-06-21 23:28:03 +09:00
Takeshi KOMIYA	2fb5232b12	Fix typo	2020-06-06 01:21:35 +09:00
Takeshi KOMIYA	07d19ebe02	Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warning ... coverage ext - config to log missing coverage	2020-06-06 01:13:41 +09:00
Christian Riedel	f33eb15b83	documented coverage_show_missing_items confval	2020-06-05 17:42:26 +02:00
Stephen Finucane	375fb52fe4	docs: Add information about Sphinx trove classifiers ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-03 22:45:11 +01:00
Stephen Finucane	e0d3e0aa8c	docs: Update reference to sphinx-contrib organization ... This is now well established on GitHub and the Bitbucket organization is no longer maintained. Update the documentation to indicate this. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 21:58:05 +01:00
Takeshi KOMIYA	800dcf0f0a	Close #2106: autodoc: Support multiple signatures on docstring	2020-05-30 15:40:21 +09:00
Takeshi KOMIYA	752d3285d2	Update docs (refs: #7469)	2020-05-21 00:56:32 +09:00
Daniel Fremont	de4aca857c	revisions per comments from tk0miya	2020-05-17 09:07:11 -07:00
Daniel Fremont	f9e9bdc4a0	Merge remote-tracking branch 'sphinx/3.x' into 3.x	2020-05-17 08:09:45 -07:00
Takeshi KOMIYA	155cb87452	doc: Fix examples of doctest extensions are still in py2 (refs: #7575)	2020-04-29 22:46:44 +09:00
Takeshi KOMIYA	037fe96dc1	Close #4030: autosummary: Add autosummary_context	2020-04-25 11:15:43 +09:00
Takeshi KOMIYA	c9e4945623	Merge pull request #7473 from eric-wieser/meta-public ... Add support for :meta public:	2020-04-23 02:15:42 +09:00
Takeshi KOMIYA	6e28675727	doc: Fix version	2020-04-21 23:38:18 +09:00
Takeshi KOMIYA	7671bcc23b	Remove autosummary_recursive configuration ... Now autosummary directive has :recursive: option to enable the recursive feature individually. So the configuration is no longer needed.	2020-04-21 23:38:18 +09:00
Takeshi KOMIYA	b9da9237bc	Merge branch '3.x' into 6040_autosummary_recursive	2020-04-21 23:04:38 +09:00
Takeshi KOMIYA	476b73b6ca	autosummary: Add :recursive: option to autosummary directive	2020-04-21 22:47:00 +09:00
Takeshi KOMIYA	dc46897768	Close #7490: autosummary: Add `:caption:` option to autosummary directive	2020-04-16 23:04:57 +09:00
Takeshi KOMIYA	19d5d8d75c	Fix #7477: imgconverter: Invoke "magick convert" command on Windows	2020-04-15 23:23:28 +09:00
Eric Wieser	0d7451c23d	Add support for :meta public: ... A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes. Rejected spellings include: * `:meta not-private:` * `:meta private: False`	2020-04-14 08:41:45 +01:00
Daniel Fremont	8ee7d908f3	updated corresponding documentation	2020-04-12 12:06:14 -07:00
PythonCoderAS	c495b2a380	Correct minor typo	2020-03-18 21:49:41 -04:00
Takeshi KOMIYA	d517aa6c16	Close #7079: Make autodoc_typehints=description formal	2020-03-07 13:19:37 +09:00
Takeshi KOMIYA	f13c546862	doc: Update docs	2020-03-07 02:00:50 +09:00
Takeshi KOMIYA	448937eb4d	doc: Remove mention about py2	2020-02-24 12:43:00 +09:00
Neal McBurnett	b620a8a6cc	Fix typos ... bad quoting, better word usage.	2020-02-09 19:12:52 -07:00
Neal McBurnett	9b125cf8e9	Clarify documentation on use of doctest extension ... When I first read this section, I was mightily confused due to lack of context and the use of the passive voice. I think this phrasing clarifies the context and indicates more clearly what the documentation author does vs what the doctest extension and builder do. But I'm a newbie here, so please ensure that I got this right....	2020-02-09 16:59:39 -07:00
Takeshi KOMIYA	e7a0af807a	Merge branch '2.0'	2020-01-30 23:29:32 +09:00
Takeshi KOMIYA	5397664d42	Add a new extension: sphinx.ext.autodoc.typehints	2020-01-25 17:56:39 +09:00
Takeshi KOMIYA	347e301727	Merge branch '2.0'	2020-01-19 22:47:02 +09:00
Takeshi KOMIYA	74a5f350a1	Add new event: autodoc-before-process-signature	2020-01-13 13:16:59 +09:00
Takeshi KOMIYA	b968bb91e9	Close #6830: autodoc: consider a member private if docstring has "private" metadata	2020-01-04 13:28:07 +09:00
Takeshi KOMIYA	0319faf8f1	Merge branch '2.0'	2020-01-01 14:40:39 +09:00
Takeshi KOMIYA	2f36d792f3	Update CHANGES for PR #5230	2020-01-01 12:59:20 +09:00
Takeshi KOMIYA	e628afd5cd	Merge branch '2.0'	2020-01-01 11:39:46 +09:00
Takeshi KOMIYA	18e25d680d	Close #6966: graphviz: Support `:class:` option	2019-12-27 22:38:10 +09:00
Takeshi KOMIYA	1fc4e8c251	Merge branch '2.0'	2019-12-25 22:44:12 +09:00
Takeshi KOMIYA	de9ee3e70a	doc: Fix sphinx.ext.duration will be added since 2.4.0	2019-12-25 22:43:56 +09:00
Takeshi KOMIYA	e83bb29789	Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass ... Close #5923: autodoc: allow not to document inherited members of specific super class	2019-12-22 16:30:56 +09:00
Takeshi KOMIYA	a209002b81	doc: Add examples for :inherited-members:	2019-12-22 16:05:45 +09:00
Takeshi KOMIYA	d47f38e22d	Merge branch '2.0'	2019-12-21 12:21:49 +09:00
Takeshi KOMIYA	29687a29f1	Close #6446: Add sphinx.ext.durations to inspect durations of build	2019-12-16 00:47:23 +09:00
Takeshi KOMIYA	fb9adbf0be	Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth ... Update docs about intersphinx and basic auth support	2019-12-03 01:42:37 +09:00
Santos Gallegos	46c68302be	Be more specific about the type of login	2019-12-02 11:07:17 -05:00
Takeshi KOMIYA	7c79a6b8d1	Close #5923: autodoc: allow not to document inherited members of specific super class	2019-12-01 12:51:28 +09:00
Takeshi KOMIYA	15c266c445	Merge branch '2.0'	2019-11-30 21:52:42 +09:00
Takeshi KOMIYA	82a6048f12	Fix typo	2019-11-28 23:31:08 +09:00
Santos Gallegos	f7c1e9190a	Linter	2019-11-27 15:38:26 -05:00
Santos Gallegos	a72d8f6808	Update docs about intersphinx and basic auth support ... This was added in #2089 but the docs don't mention it.	2019-11-27 15:23:52 -05:00
Takeshi KOMIYA	82b2b1752a	doc: URL of numpydoc has changed	2019-11-27 00:12:32 +09:00
Takeshi KOMIYA	66c3dd3adb	Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file	2019-11-16 18:19:31 +09:00
Takeshi KOMIYA	01f8dad160	Merge branch '2.0'	2019-08-19 00:37:30 +09:00
jfbu	4ae5414ee5	Update our docs for imgmath_latex (refs: #6610)	2019-08-03 12:00:24 +02:00
jfbu	47cd262b3e	Merge branch '2.0'	2019-08-01 18:30:48 +02:00
jfbu	7c59e44eaa	Fix version changed info in our document for imgmath	2019-08-01 18:24:28 +02:00
jfbu	da3763170e	Reorganize documentation of the imgmath configuration variables	2019-08-01 17:52:28 +02:00
jfbu	505ff622c2	More robust code for getting saved "depth" of svg inline math snippet	2019-08-01 17:52:28 +02:00
jfbu	1adf12bfa7	Make imgmath_use_preview work also for svg output	2019-08-01 17:52:28 +02:00
woutdenolf	9dc9b8754d	Merge with master and address code review	2019-07-08 08:29:23 +02:00
Takeshi KOMIYA	4af90fcf75	Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file	2019-07-07 16:18:49 +09:00
Takeshi KOMIYA	c18dcf08f9	Merge branch '2.0'	2019-06-30 01:08:48 +09:00
Takeshi KOMIYA	828beb12e0	doc: Update document for :annotation: option (refs: #6495)	2019-06-29 18:43:30 +09:00
Takeshi KOMIYA	5d42659e33	Merge branch '2.0'	2019-06-15 23:39:44 +09:00
woutdenolf	ec8656bd27	[autosummary] remove recursion limit and module/package separation	2019-06-02 16:26:40 +02:00
Takeshi KOMIYA	ce2f9c2b94	Close #5124: graphviz: :graphviz_dot: option is renamed to :layout:	2019-06-02 21:33:34 +09:00
Takeshi KOMIYA	c4f44bdd22	Merge branch '2.0'	2019-06-02 21:17:38 +09:00
Takeshi KOMIYA	1303ea7cdf	docs: Use directive:option in extensions/graphviz	2019-06-02 18:18:55 +09:00
Takeshi KOMIYA	91fceb4b5f	Merge branch '2.0.2' into 2.0	2019-06-02 00:58:46 +09:00
woutdenolf	4fb58b2146	[autosummary] doclint violation	2019-06-01 13:08:23 +02:00
woutdenolf	140ae00baa	Merge branch 'master' into feature-autosummary-packages	2019-06-01 12:42:28 +02:00
Takeshi KOMIYA	ce3c5735cd	Merge branch '2.0'	2019-06-01 01:45:47 +09:00
Takeshi KOMIYA	2afba22cee	Merge pull request #6397 from tk0miya/6361_autodoc_typehints ... Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature	2019-06-01 01:07:37 +09:00
Takeshi KOMIYA	d6063ff35b	doc: Fold lines by 80 columns	2019-05-30 01:07:05 +09:00
Takeshi KOMIYA	b9d7239d90	Merge branch '2.0'	2019-05-29 00:51:25 +09:00
Takeshi KOMIYA	9b2423c5bb	doclinter: restrict by 90 columns	2019-05-26 10:53:53 +09:00
Takeshi KOMIYA	0ea380eddd	Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature	2019-05-26 00:35:24 +09:00
woutdenolf	1a67b87910	Merge branch 'master' into feature-autosummary-packages	2019-05-18 14:42:34 +02:00
Adrián Chaves	e84ba7f78a	Support coverage_ignore_pyobjects in the coverage builder	2019-05-15 12:23:05 +02:00
jfbu	48ad83d061	Reorganize documentation of the imgmath configuration variables	2019-04-24 12:30:18 +02:00
jfbu	ea28bd9fb0	More robust code for getting saved "depth" of svg inline math snippet	2019-04-24 11:56:19 +02:00
jfbu	3edcff7952	Make imgmath_use_preview work also for svg output	2019-04-23 15:13:21 +02:00
jfbu	6009140f22	Fix a dvisvgm link in docs and add preview-latex link	2019-04-17 10:07:30 +02:00
Alex Sergeev	98691baf85	Address comments	2019-04-14 10:47:50 -10:00
Alex Sergeev	4bad5bd419	Address feedback	2019-04-13 20:54:20 -10:00
woutdenolf	6e0b0517c0	[autosummary] address code review	2019-04-07 12:00:57 +02:00
woutdenolf	4004dd5635	Merge branch 'master' into feature-autosummary-packages	2019-04-07 10:32:57 +02:00
Takeshi KOMIYA	338941a49a	Fix #6213: ifconfig: contents after headings are not shown	2019-04-05 02:34:23 +09:00
Takeshi KOMIYA	005913630f	Add missing versionadded for autosummary_mock_imports	2019-04-04 23:49:43 +09:00
Takeshi KOMIYA	6cb263b9c8	Merge pull request #6212 from tsanikgr/feature/autosummary_imported_members ... Allow setting imported_members for autosummary in conf.py	2019-04-04 23:04:36 +09:00
tsanikgr	eb03b1406f	Simplify docs	2019-04-03 17:31:16 +01:00
Richard Darst	277588f2f9	Clarify MathJax extension usage: edits from review	2019-03-29 16:40:18 +02:00
Richard Darst	dd0246c6dc	Clarify MathJax extension usage ... - We recently hit an issue where we expected the MathJax extension to work with the default MathJax markup. Obviously that shouldn't be the case (since then other formats couldn't use the math), but it can't hurt to include a hint. - Link from the math HTML extension page to the relevant roles/directives. - Also make it explicit that MathJax has a default, and that it's an external resource that will be dynamically linked.	2019-03-27 18:10:09 +02:00
tsanikgr	bec116a3b6	#5877: Allow setting imported_members for autosummary in conf.py	2019-03-27 14:19:16 +00:00
Michael Goerz	4e27cc465a	Fix docs of inheritance-diagram "parts" option ... The documentation now correctly describes the behavior of the ``parts`` option in an inheritance-diagram directive: it gives the number of parts that are *kept* not dropped. The option now also accepts negative values, which drops parts from the left (which is the what the documentation incorrectly claimed the option would do for positive values) As a form of testing of the new functionality, the documentation for the inheritance_diagram extension now includes a section "Examples" that demonstrate the different possibilities. This would fail to build without the patch. Closes #4872	2019-03-19 01:19:29 +09:00
Michael Goerz	1f136215c1	Fix docs of inheritance-diagram "parts" option ... The documentation now correctly describes the behavior of the ``parts`` option in an inheritance-diagram directive: it gives the number of parts that are *kept* not dropped. The option now also accepts negative values, which drops parts from the left (which is the what the documentation incorrectly claimed the option would do for positive values) As a form of testing of the new functionality, the documentation for the inheritance_diagram extension now includes a section "Examples" that demonstrate the different possibilities. This would fail to build without the patch. Closes #4872	2019-03-10 18:37:05 -04:00
Takeshi KOMIYA	ceef713e79	docs: Remove a term "new" from config values	2019-02-27 01:18:57 +09:00
woutdenolf	33e7b76c32	Merge branch 'master' into feature-autosummary-packages	2019-02-24 12:16:52 +01:00
woutdenolf	cb51216cac	[autosummary] modify docs	2019-02-24 12:12:33 +01:00
Takeshi KOMIYA	686486498c	Closes #1148: autodoc: Add autodecorator directive for decorators	2019-02-15 02:14:38 +09:00
Takeshi KOMIYA	550c88f98c	Merge pull request #6064 from tk0miya/5636_add_autosummary_mock_imports ... Closes #5635: autosummary: Add autosummary_mock_imports to mock external libraries	2019-02-14 01:13:04 +09:00
Takeshi KOMIYA	73b8d6ff33	Closes #5636: autosummary: Add autosummary_mock_imports to mock external libraries	2019-02-11 23:19:25 +09:00
Takeshi KOMIYA	9f3feb6315	docs: autosectionlabel_maxdepth	2019-02-11 18:21:41 +09:00
Takeshi KOMIYA	057ef31182	Fix typo	2019-02-11 13:25:24 +09:00
Takeshi KOMIYA	54be6ae494	Merge pull request #6053 from tk0miya/5459_autodoc_default_options_accepts_True ... Closes #5459: autodoc: autodoc_default_options accepts True as a value	2019-02-11 12:48:43 +09:00
Takeshi KOMIYA	37ce1eb3b3	docs: githubpage now supports CNAME file	2019-02-11 12:46:35 +09:00
Takeshi KOMIYA	b0148c6921	Closes #5459: autodoc: autodoc_default_options accepts True as a value	2019-02-11 02:03:09 +09:00
woutdenolf	555e675947	[autosummary] add modules and packages for modules	2019-02-08 16:10:43 +01:00
jfbu	32d57b8637	Merge branch '1.8' ... resolved Conflicts: doc/development/tutorials/todo.rst sphinx/locale/__init__.py sphinx/search/zh.py	2018-12-28 12:50:20 +01:00
jfbu	1e07cb10fc	Fix various spelling typos	2018-12-27 13:06:33 +01:00
Takeshi KOMIYA	5b2befe97d	doc: Fix description for viewcode_follow_imported_members	2018-12-23 22:13:33 +09:00
Jon Dufresne	bade33c7e4	Remove unnecessary encoding cookie from Python source files ... In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.	2018-12-16 12:22:12 -08:00
Eric N. Vander Weele	9fcef5030a	autodoc: Respect member-order in autodoc_default_options as documented ... In the `autodoc_default_options` documentation, it mentions that `member-order` is respected; however, when setting the key-value pair in `conf.py`, it is not. Thus, add `member-order` as one of the default options respected in `conf.py`. Additionally, update the list of supported options to match the example.	2018-10-16 10:21:18 -07:00
Jon Dufresne	dd383ec472	Prefer https:// links where available	2018-09-23 11:50:42 -07:00
Rob Ruana	e547a6a0d2	Fixes #5426: [Napoleon] Better handling of inline attributes (#5470) ... * Fixes #5426: [Napoleon] Better handling of inline attributes * Removes uneeded NOQA comments * Fixes imports	2018-09-23 09:26:17 -04:00
Jon Dufresne	490e4aed41	Remove unnecessary object from class definitions ... In Python 3, all classes are new-style classes. The object in the definition is redundant and unnecessary.	2018-09-11 07:07:01 -07:00
Takeshi KOMIYA	342de4f0fd	Merge branch '1.8'	2018-09-05 23:10:20 +09:00
Takeshi KOMIYA	daac35cda7	doc: Add versionadded label (refs: #5029)	2018-09-03 10:46:38 +09:00
Takeshi KOMIYA	8c4de32c7d	Fix #4182: autodoc: Support :confval:suppress_warnings	2018-08-26 23:29:00 +09:00
Takeshi KOMIYA	472001eeb7	Fix typo	2018-08-22 11:08:33 +09:00
Takeshi KOMIYA	e3f383ad7c	Merge pull request #5315 from tk0miya/add_autodoc_default_options ... Add autodoc_default_options	2018-08-20 00:26:08 +09:00
Takeshi KOMIYA	17874a1a4b	Merge pull request #5297 from AWhetter/viewcode_follow_imported_event ... Plugins can resolve imported members for viewcode	2018-08-19 23:45:09 +09:00
Takeshi KOMIYA	3d9e2cf831	Add autodoc_default_options	2018-08-18 18:22:16 +09:00
Lewis Haley	f196a92055	autodoc: add 'exclude-members' to user global options ... As the previous commit explains, it is now possible to specify arguments to the global options in config files. This means that we can now include the `exclude-members` option in this global configuration. Previously, there was no point including this option because it makes no sense without arguments. Including this option means users have the flexibility of explicitly including which special methods they want using (e.g.): :special-members: __init__, __iter__ or explicitly excluding which special-members (or other members) they want using (e.g.): :exclude-members: __weakref__, __hash__	2018-08-17 16:02:11 +01:00
Lewis Haley	6e1e35c98a	autodoc: allow specifying values to global arguments ... Previously, users could specify a *list* of flags in their config files. The flags were directive names that would otherwise be present in the .rst files. However, as a list, it was not possible to specify values to those flags, which *is* possible in .rst files. For example, in .rst you could say :special-members: __init__, __iter__ And this would cause autodoc to generate documents for these methods that it would otherwise ignore. This commit changes the config option to instead accept a dictionary. This is a dictionary whose keys can contain the same flag-names as before, but whose values can contain the arguments as seen in .rst files. The old list is still supported, for backwards compatibility, but the data is transformed into a dictionary when the user's config is loaded.	2018-08-17 15:51:00 +01:00
Antti Kaihola	43d5810083	Ref #5273: doctest: add documentation for the :skipif: option	2018-08-16 14:01:57 +03:00
Ashley Whetter	97164faec3	Plugins can resolve imported members for viewcode	2018-08-13 17:07:50 -07:00
Takeshi KOMIYA	da7a06b323	WIP: #726, #969: Add mathjax_config	2018-07-29 22:36:53 +09:00
Takeshi KOMIYA	e045dacc84	doc: Move description for math confval, directives and roles to usage	2018-07-28 18:43:02 +09:00
Takeshi KOMIYA	1140e81df7	Merge remote-tracking branch 'stephenfin/doc-rework'	2018-06-26 01:05:19 +09:00
Stephen Finucane	d9ccc95717	doc: Add "extensions" to usage guide ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-06-20 09:30:47 +01:00