243 Commits

Author	SHA1	Message	Date
Jakob Lykke Andersen	3bf8bcd6e1	intersphinx role, update docs	2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen	540d76035c	intersphinx role, documentation	2022-01-16 09:48:06 +01:00
Takeshi KOMIYA	a87153c018	autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format (refs: #9931)	2021-12-24 10:14:19 +09:00
Takeshi KOMIYA	733ac6ed5f	doc: Update explanation of autodoc_unqualified_typehints (ref: #9931)	2021-12-18 15:26:42 +09:00
Takeshi KOMIYA	c71ff1cd21	Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints ... If autodoc_unqualified_typehints feature enabled, autodoc suppresses the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`)	2021-12-03 18:05:49 +09:00
Takeshi KOMIYA	15d834e4d8	Merge pull request #9831 from Yoshanuikabundi/autosummary___all__ ... Allow autosummary to respect __all__	2021-11-26 02:15:43 +09:00
Takeshi KOMIYA	e2c6146b3e	Fix #9864: mathjax: Failed to render equations via MathJax v2 ... MathJax library has been loaded via "defer" method since v4.3.0. But it prevents to work MathJax v2. This rollbacks the change and use "async" method as default again. To support changing the loading method, this allows to specify it via mathjax_options.	2021-11-21 18:27:35 +09:00
Josh Mitchell	79089b5fa4	Corrections from review by tk0miya	2021-11-15 13:18:47 +11:00
Josh Mitchell	ad0071ddb7	#2021: Allow autosummary to respect __all__	2021-11-15 13:16:33 +11:00
Jakob Lykke Andersen	56002be5e1	rename intersphinx_disabled_{refs -> reftypes} ... And change format for domains to {name}:*	2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen	484d74ad97	intersphinx_disabled_refs, doc default value	2021-10-31 13:42:26 +01:00
Jakob Lykke Andersen	cfbac2ceaa	intersphinx_disabled_refs, rename 'all' to '*'	2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen	0d9f4cd469	Generalize to disable specific refs as well.	2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen	c88c718397	Fix typo	2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen	f22faa7e06	Add intersphinx_disabled_domains ... Fixes sphinx-doc/sphinx#2068 Replaces sphinx-doc/sphinx#8981	2021-10-31 13:15:47 +01:00
Gabe R	1bc98b7860	Add missing space in intersphinx doc ... There was a space missing between `-m` and `sphinx.ext.intersphinx` in the example of showing all mappings in a intersphinx file. I added it in.	2021-10-19 11:33:23 -07:00
Takeshi KOMIYA	481c5e9c4b	Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code ... New Sphinx tutorial, part III	2021-10-09 13:05:48 +09:00
Takeshi KOMIYA	d13b86e02f	Close #9664: autodoc: autodoc-process-bases supports reST snippet ... This allows to inject a reST snippet through autodoc-process-bases event. It helps to modify the base classes of any class to the expected mark-up'ed text by custom extension.	2021-09-23 10:59:01 +09:00
Takeshi KOMIYA	8416813168	Merge pull request #9616 from jdufresne/fix-url ... Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g	2021-09-11 17:16:47 +09:00
Christian Clauss	86583c578c	Fix typos discovered by codespell	2021-09-08 02:15:25 +02:00
Jon Dufresne	7dd112b110	Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g ... https://sphinx-doc.org is unreachable, but is linked from the PyPI page: https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/ instead.	2021-09-06 13:15:48 -07:00
Juan Luis Cano Rodríguez	a606db01f1	Add section on autosummary	2021-08-12 20:09:50 +02:00
Takeshi KOMIYA	6e87c17a76	doc: Add document for autoproperty directive (refs: #9486)	2021-07-23 23:10:48 +09:00
Juan Luis Cano Rodríguez	b9da1577b6	Merge branch '4.x' into new-tutorial-part-ii	2021-07-05 20:12:53 +02:00
Juan Luis Cano Rodríguez	6f9bc6e7e5	Use "builtin" for extensions label as it is done for themes	2021-07-05 09:32:10 +02:00
Takeshi KOMIYA	0ee0d8df00	Merge pull request #9399 from tk0miya/napoleon_preprocess_types ... doc: Fix the default value of napoleon_preprocess_types is True	2021-07-04 11:26:43 +09:00
Takeshi KOMIYA	f6b3f36e23	doc: Fix the default value of napoleon_preprocess_types is True	2021-07-03 17:41:57 +09:00
Louis-Justin TALLOT	a52ccdbfc7	Fix quotes in docstring in ext.napoleon	2021-06-30 19:40:35 +02:00
Juan Luis Cano Rodríguez	1e49218993	Add tutorial section about extensions and themes	2021-06-17 00:21:42 +02:00
Takeshi KOMIYA	e0500f7354	doc: Fix docslint misunderstanding scope of code-blocks	2021-06-06 13:24:06 +09:00
Takeshi KOMIYA	549f09e048	Merge pull request #9239 from igo95862/https-links ... Upgrade URLs to use HTTPS	2021-05-19 22:59:19 +09:00
igo95862	b6c2edb5ca	doc: Upgraded mathjax documentation link to HTTPS	2021-05-17 20:39:14 +03:00
igo95862	cfa449624d	doc: Moved Jinja links to new home page and HTTPS ... Seems like Jinja is no longer pocoo project but palletsprojects.com	2021-05-17 20:38:48 +03:00
Takeshi KOMIYA	bc7087a1a2	Merge branch '4.x' into 3014_autodoc-process-bases	2021-05-17 22:40:27 +09:00
igo95862	29aaf20a11	doc: Upgraded some of sphinx-doc.org links to HTTPS ... Seems like that link is used in some tests and code so upgrading it outside documentation might break something	2021-05-16 16:37:36 +03:00
igo95862	e67c9e5df1	doc: Upgrade docutils.sourceforge.io links to HTTPS ... Also change any docutils.sourceforge.net link to io top level domain.	2021-05-16 15:53:49 +03:00
Takeshi KOMIYA	51ae283a38	Close #4257: autodoc: Add autodoc_class_signature ... Add `autodoc_class_signature` to separate the class entry and the definition of `__init__()` method.	2021-05-16 01:53:48 +09:00
Takeshi KOMIYA	67db20d705	Close #3014: autodoc: Add autodoc-process-bases ... Add `autodoc-process-bases` to modify the base classes of the class definitions. This allows the extensions to insert or modify the list of the base classes via event-handlers.	2021-05-16 00:46:06 +09:00
Takeshi KOMIYA	0b0414ea17	Update "versionadded" in doc/usage/extensions/autodoc.rst	2021-05-12 00:04:43 +09:00
Ashley Whetter	28d3f8136e	autodoc.typehints can accurately represent overloads	2021-05-08 21:34:25 -07:00
Takeshi KOMIYA	d8a9f243e2	Close #8107: autodoc: Add class-doc-from option to autoclass directive ... Add `class-doc-from` option to the `autoclass` directive to control the content of the specific class. It takes `class`, `init`, and `both` like `autoclass_content`.	2021-05-01 14:53:06 +09:00
Matthias Geier	7b9cc0563d	Add documentation for mathjax2_config and mathjax3_config	2021-04-24 10:50:37 +02:00
Takeshi KOMIYA	668bc9eec9	Merge branch '4.0.x' into 4.x	2021-04-19 01:08:54 +09:00
Harmon	5af55008b3	doc: Fix grammar in documentation for autodoc_typehints	2021-04-14 16:41:25 -05:00
Takeshi KOMIYA	32337c3ba7	Merge pull request #9084 from tk0miya/8731_docs_for_napoleon_preprocess_types ... doc: Add docs for napoleon_preprocess_types	2021-04-13 01:15:44 +09:00
Takeshi KOMIYA	d59e96c8b4	docs: Add versionchanged tag to extlinks (refs: #8898)	2021-04-11 22:25:48 +09:00
Merry Bass	75605d437f	fixup! sphinx.ext.extlinks: Clarify escaping of `%`	2021-04-11 22:14:24 +09:00
Merry Bass	ef1747f03a	sphinx.ext.extlinks: Clarify escaping of `%` ... We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``. Clarify this behaviour for the caption and base URL strings.	2021-04-11 22:14:17 +09:00
Merry Bass	fb39974486	sphinx.ext.extlinks: Allow `%s` in link caption string ... Tweak syntax of extlinks to also allow ``%s`` in the link caption part. Like for the base URL ``%s`` will be substituted with the content of the role. This allows configurations like extlinks = {'quarter': ('https://example.org/quaters/%s', '%s. quarter')} with ``:quarter:`2``` getting replaced by a link titled `2. quarter`. The requirement for the caption string is to be either None or contain exactly one ``%s``. If neither is the case, then we emit a warning and fall back to the old behaviour which is concatenating the caption string with the role content.	2021-04-11 22:14:01 +09:00
Takeshi KOMIYA	d09747f225	doc: Add docs for napoleon_preprocess_types	2021-04-11 21:35:47 +09:00