603 Commits

Author	SHA1	Message	Date
Takeshi KOMIYA	5460ea103b	Merge branch '3.x'	2021-01-08 01:23:17 +09:00
Takeshi KOMIYA	a9c7dd7037	Merge branch '3.x'	2021-01-03 00:20:27 +09:00
Takeshi KOMIYA	e9a4ebf70d	doc: Add explanation for the priority attribute of html_*_files	2021-01-03 00:16:10 +09:00
Hong Xu	1f020196a7	DOC: modules are only available when recursive is on ... See 7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)	2021-01-01 11:12:58 -08:00
Takeshi KOMIYA	a122397b4b	Merge branch '3.x'	2020-12-29 18:37:45 +09:00
Takeshi KOMIYA	150f788e0e	Merge pull request #8600 from tk0miya/8132_project_copyright ... Close #8132: Add project_copyright confval as an alias of copyright	2020-12-28 17:26:49 +09:00
Hong Xu	d9ca895dbb	Update autodoc.rst	2020-12-27 21:24:19 -08:00
Hong Xu	6927130ff1	Doc: Correct type: "TypeAlias" -> "AliasType"	2020-12-27 21:23:31 -08:00
Takeshi KOMIYA	c5a9d04d45	Merge branch '3.x' into 8132_project_copyright	2020-12-28 13:56:11 +09:00
Takeshi KOMIYA	c7d1536828	Close #8132: Add project_copyright confval as an alias of copyright ... Avoid to pylint error, add a new config variable; project_copyright as an alias of `copyright`.	2020-12-27 18:40:06 +09:00
Takeshi KOMIYA	9e9e486e65	Close #8022: autodoc: Allow to hide the value of the variables via metadata ... autodata and autoattribute directives does not show right-hand value of the variable if its docstring contains ``:meta hide-value:`` in info-field-list.	2020-12-27 12:46:03 +09:00
Takeshi KOMIYA	2c98e909bf	Merge branch '3.x'	2020-12-14 02:02:29 +09:00
Ned Batchelder	bac6ab8d0c	Describe the intersphinx mapping a bit more	2020-12-13 08:04:55 -05:00
Takeshi KOMIYA	1d9eeedde3	Fix #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese ... Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese docs (refs: #4186, #6841). uplatex is able to build a document without conversion character encoding internally. It allows using unicode characters in documents. Additionally, uplatex is compatible with platex (current default latex_engine for Japanese docs). This changes the default latex_engine for Japanese document to uplatex.	2020-11-29 15:09:49 +09:00
Takeshi KOMIYA	da4c69c624	Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations ... Fix #8285: napoleon can use PEP526 annotations	2020-11-28 18:11:30 +09:00
François Freitag	6b90a63f08	Fix #6629: linkcheck: Handle rate-limiting ... Follow the Retry-After header if present, otherwise use an exponential back-off.	2020-11-25 17:34:55 +01:00
Quentin Soubeyran	ec30f77712	refactored code and tests, prepared for numpy feature	2020-11-25 08:45:25 +01:00
Quentin Soubeyran	f268665292	added napoleon_google_attr_annotations option to use PEP 526 on google style	2020-11-25 08:45:25 +01:00
Takeshi KOMIYA	3a4ae2092a	Merge branch '3.x'	2020-11-21 01:01:36 +09:00
Takeshi KOMIYA	5676fdeb4e	Rename :novalue: option to :no-value: option ... According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option.	2020-11-15 14:20:30 +09:00
Marlon James	6082ce67a4	autodoc: document :novalue: option	2020-11-15 14:19:33 +09:00
Takeshi KOMIYA	7eabbfc5ec	Merge pull request #8284 from tk0miya/7996_man_make_section_directory_by_default ... Close #7996: manpage: Make a section directory on build manpage by default	2020-10-28 11:03:13 +09:00
Takeshi KOMIYA	c40b4249cd	Merge branch '3.x' into master	2020-10-28 02:23:36 +09:00
Takeshi KOMIYA	a843fd3db8	Close #7996: manpage: Make a section directory on build manpage by default	2020-10-28 02:15:36 +09:00
Pradyun Gedam	18b2f2cdf2	Reword section on Third Party Themes ... - No longer attempt to be the location for listing themes -- only Sphinx-RTD-Theme was listed here. - Mention the classifier used when searching on PyPI. - Emphasize sphinx-themes.org as a gallery of themes.	2020-10-21 11:16:59 +05:30
Thomas Grainger	3f26564c28	Apply suggestions from code review	2020-10-05 22:10:25 +01:00
Thomas Grainger	3eecf133d8	Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub builder	2020-10-05 09:29:16 +01:00
Takeshi KOMIYA	598b85da75	Merge branch '3.x' into master	2020-10-04 22:41:44 +09:00
Takeshi KOMIYA	178c05b059	Close #7996: manpage: Add man_make_section_directory ... Add a new config variable; man_make_section_directory to make a section directory on build man page. During 3.x, it defaults to False and will be changed to True on 4.0 release.	2020-10-03 22:30:20 +09:00
François Freitag	5166dd194c	Strip trailing whitespaces and normalize line endings ... Trailing whitespace do not have impact on the result, they are just unused bytes. Most text editors are configured to strip trailing whitespaces. Remove them all in one go. Update a handful of files to use the UNIX line ending.	2020-10-03 13:47:01 +02:00
Takeshi KOMIYA	f2c0dfe7c4	Close #6518: autodoc: Add autodoc_type_aliases ... autodoc_type_aliases allows to keep user defined type alises not evaluated in the generated document.	2020-10-03 16:03:35 +09:00
Takeshi KOMIYA	26ea870267	Merge branch '3.x' into master	2020-10-03 13:43:21 +09:00
Steve Piercy	81d7f2ee8a	Update link to sphinxcontrib on GitHub	2020-09-26 16:32:59 -07:00
Bradley Dice	a0116eaa58	Fix typo: anchestor -> ancestor.	2020-09-20 17:36:01 -05:00
Tetsuo Koyama	9fe3fe4f6b	Add "Getting Started as a Translator"	2020-09-20 01:08:21 +09:00
Tetsuo Koyama	eef2f2a8b6	✏️ Fix grammer	2020-09-20 00:53:57 +09:00
Jakob Lykke Andersen	500f45fd4c	C, recursive alias declarations ... Fixes sphinx-doc/sphinx#8141	2020-09-13 16:37:53 +02:00
Takeshi KOMIYA	bec30596a8	Merge branch '3.x' into master	2020-09-13 10:54:21 +09:00
Falko Axmann	849ef212bc	Fixes minor typo in quickstart.rst	2020-08-30 14:39:20 +02:00
Takeshi KOMIYA	8412347f5d	Merge branch '3.x'	2020-08-14 14:28:58 +09:00
Takeshi KOMIYA	dab15e2857	Merge pull request #8058 from nijel/single-domain ... i18n: Add support for having single text domain	2020-08-14 14:21:43 +09:00
Adam J. Stewart	fa8ad979af	sphinx.ext.autodoc: fix typo in docs	2020-08-11 11:05:00 -05:00
Takeshi KOMIYA	a8927bcd3e	Merge branch '3.x'	2020-08-08 18:16:59 +09:00
Michal Čihař	1bf7fe424e	i18n: Add support for having single text domain ... The gettext_compact can now be a string which is then a single domain for all documents. Fixes #784	2020-08-07 20:22:30 +02:00
Matt from Documatt	db9375363c	Add link to third party themes on GitLab ... GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.	2020-08-07 14:46:19 +02:00
Takeshi KOMIYA	f743be0054	Merge pull request #8047 from cjmayo/typos ... Assorted typos including sphinx-buid in internationalization figure	2020-08-06 02:38:07 +09:00
Takeshi KOMIYA	059dc108ba	Close #6698: doctest: Add :no-trim-doctest-flags: options ... To control trimming doctest flags manually, this adds new options :trim-doctest-flags: and :no-trim-doctest-flags: to doctest directives. It helps to describes doctest module itself in python doc (see #6698).	2020-08-05 23:39:05 +09:00
Chris Mayo	fe4a158caf	Fix typos in the documentation	2020-08-03 19:30:38 +01:00
Takeshi KOMIYA	57af828882	Merge pull request #8035 from tk0miya/8034_argument_for_private-members ... Close #8034: autodoc: :private-member: can take an list of member names	2020-08-03 01:57:13 +09:00
Takeshi KOMIYA	af15593c0c	Close #7768: i18n: figure_language_filename supports {docpath} token ... To build structured i18n imaging directory, figure_language_filename now supports `{docpath}` token that is a dirname of the current document.	2020-08-02 16:28:54 +09:00
Takeshi KOMIYA	d7a84e83cc	Close #8034: autodoc: :private-member: can take an list of member names ... Now :private-member: option can take an explicit list of member names to be documented as its arguments (like :special-members: does).	2020-08-02 01:27:14 +09:00
Takeshi KOMIYA	c14c00397e	Merge branch '3.x'	2020-08-01 16:59:00 +09:00
Ebram Shehata	df2d4839c4	Update basics.rst	2020-07-29 15:14:29 +02:00
Chris Holdgraf	84f7dffd99	comments	2020-07-29 10:38:18 +01:00
Chris Holdgraf	c7085162d1	rearranging a few docs and small updates	2020-07-29 10:38:18 +01:00
Chris Holdgraf	729dcd0e03	flake8	2020-07-29 10:38:18 +01:00
Chris Holdgraf	60b105d6aa	several documentation improvements to theming, templating, and extension development	2020-07-29 10:38:18 +01:00
Takeshi KOMIYA	3336dcc2ae	Merge pull request #7997 from sphinx-doc/fix/6863 ... fix 6863: add description literalinclude option (start/end have same string)	2020-07-25 22:53:48 +09:00
Yoshiki Shibukawa	70aa913bb2	fix 6863: add description literalinclude option (start/end have same string)	2020-07-25 22:36:06 +09:00
Takeshi KOMIYA	778e297577	Update CHANGES for PR #7690	2020-07-25 21:45:13 +09:00
Takeshi KOMIYA	ac0a800265	Merge pull request #7690 from keewis/transform_numpy_parameter_types ... preprocessing numpy types	2020-07-25 21:41:32 +09:00
Keewis	6ae1c601b9	add a section about napoleon_type_aliases to the documentation	2020-07-25 11:49:58 +02:00
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
Takeshi KOMIYA	327c187284	Merge branch '3.x'	2020-07-24 23:49:45 +09: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	746cf3505c	Merge branch 'master' into mathjax-3	2020-07-24 11:53:27 +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
Takeshi KOMIYA	897be0ebae	Close #7784: i18n: The alt text for image is translated by default ... Make alt text for image translatable by default without settings of gettext_additional_targets.	2020-07-19 12:58:28 +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
Jakob Lykke Andersen	18b00d8cff	Add docs and CHANGES for C changes	2020-07-14 11:48:58 +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
Takeshi KOMIYA	e31fce0766	Close #7902: html theme: Add a new option globaltoc_maxdepth	2020-07-11 23:11:59 +09:00
Takeshi KOMIYA	70d521ad9c	Merge branch '3.x'	2020-07-11 21:59:58 +09:00
Takeshi KOMIYA	6dfbc5108e	Close #7849: html: Add html_codeblock_linenos_style	2020-07-11 20:59:38 +09:00
Joel Nothman	72ca2bdffc	Add autosummary_filename_map config to avoid clashes	2020-07-08 16:51:57 +10:00
Takeshi KOMIYA	d2fdc851fa	doc: Add translation.png to build latexpdf successfully	2020-07-07 22:19:21 +09:00
Takeshi KOMIYA	1a223209f2	Merge branch '3.x'	2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen	09e057edf2	Merge pull request #7906 from jakobandersen/noindexentry ... Add :noindexentry: option	2020-07-05 09:25:18 +02:00
Jakob Lykke Andersen	c668500a4b	Add :noindexentry: option ... Fixes sphinx-doc/sphinx#7052	2020-07-04 19:34:00 +02:00
Takeshi KOMIYA	ec3754bd94	Merge branch '3.x'	2020-07-05 01:32:54 +09:00
Takeshi KOMIYA	44f4b2ad97	Merge tag 'v3.1.0'	2020-07-05 00:10:47 +09:00
Takeshi KOMIYA	0c24baaa0c	doc: Update docs (refs: #7907)	2020-07-04 11:56:45 +09:00
Tim Metzler	5ba5cb60e3	Use double backticks for filename example	2020-07-03 19:08:53 +02:00
Tim Metzler	3982d526b2	Shorten line to less than 85 characters	2020-07-03 14:27:14 +02:00
Tim Metzler	9dcd88709c	Clarify language specific figures format ... I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. I replaced the underscores by periods and added a small example.	2020-07-03 14:11:53 +02:00
Jakob Lykke Andersen	8c82ecbf2c	Merge pull request #7895 from jakobandersen/c_cpp_noindex ... C, C++: remove noindex option	2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen	ff5eb7cc2b	C, C++: remove noindex option ... The option did nothing. Improve error messages on duplicates.	2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen	7cbf54c210	C, add c:alias directive	2020-06-30 11:20:17 +02: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
Stefano David	f4cb82cd84	documentation for proper code-block cross-referencing	2020-06-07 18:06:51 +02: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
Takeshi KOMIYA	068b9b5738	Merge branch '3.x'	2020-06-04 00:18:30 +09: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	a7725ad8ca	Close #7247: linkcheck: Add linkcheck_request_headers	2020-06-01 01:48:46 +09:00
Takeshi KOMIYA	34f3579330	Merge pull request #7748 from tk0miya/2106_autodoc_docstring_signature_for_overloads ... Close #2106: autodoc: Support multiple signatures on docstring	2020-05-31 14:48:41 +09:00
Takeshi KOMIYA	350f5b3600	Merge pull request #7751 from stephenfin/doc/intro-section ... [doc] Remove the intro guide in favour of the quickstart guide	2020-05-31 01:12:35 +09:00
Stephen Finucane	97d1b323b7	docs: Merge intro and quickstart guide ... The intro guide mostly contained out-of-date information or information that was duplicated from elsewhere. Remove it in favour of an enhanced quickstart guide. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:25:45 +01:00
Stephen Finucane	f07ad49c22	docs: Add usage, development index page ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:24:40 +01:00
Stephen Finucane	ceb72f9cd7	doc: Rework "latex" document ... Remove some unnecessary indentation, consistently document option defaults, and fix some wrapping and whitespace. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:23:36 +01:00
Takeshi KOMIYA	800dcf0f0a	Close #2106: autodoc: Support multiple signatures on docstring	2020-05-30 15:40:21 +09:00
Kai Welke	0ee57a6f6e	Fixed broken link to pygments lexers doc	2020-05-26 09:35:47 +02:00
Michaël Defferrard	5e5bd748e6	remove repeted word in reStructuredText Primer	2020-05-20 22:30:58 +02: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	3c7d35d2a2	Merge branch '3.x'	2020-05-17 19:12:56 +09:00
Takeshi KOMIYA	b1554ae25a	doc: Fix wrong version info	2020-05-10 01:12:39 +09:00
Takeshi KOMIYA	e5dad73cf2	py domain: Add :canonical: option	2020-05-04 14:49:50 +09:00
Takeshi KOMIYA	f82151bda5	Merge branch '3.x'	2020-05-02 10:43:10 +09:00
Takeshi KOMIYA	71eddf3095	Merge branch '3.x'	2020-04-30 21:49:28 +09: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	aa773cbc88	Merge branch '3.x'	2020-04-28 01:42:37 +09:00
Takeshi KOMIYA	87308d9607	Close #7143: py domain: Add :final: option to py:*: directives	2020-04-28 01:24:29 +09:00
Takeshi KOMIYA	42aa293679	Merge branch '3.x'	2020-04-27 00:54:23 +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	c2c95ef587	Merge pull request #7411 from tk0miya/latex_theme_options ... LaTeX: Add `latex_theme_options` to override theme options	2020-04-20 01:50:06 +09:00
Takeshi KOMIYA	12cb90c3fa	Merge pull request #7492 from tk0miya/7490_autosummary_caption ... Close #7490: autosummary: Add ``:caption:`` option to autosummary directive	2020-04-20 00:52:45 +09:00
Takeshi KOMIYA	05aff200b1	LaTeX: Add :confval:latex_theme_options to override theme options	2020-04-20 00:51:08 +09:00
Takeshi KOMIYA	68375c92f2	Fix #7488: Update docs	2020-04-19 23:01:57 +09:00
Takeshi KOMIYA	adad0e62bb	Merge branch '3.x'	2020-04-18 21:54:31 +09:00
Takeshi KOMIYA	1e3ce31b03	Merge pull request #7443 from mgeier/theme-options-toctree ... Add globaltoc_collapse and globaltoc_includehidden options	2020-04-16 23:11:28 +09:00
Takeshi KOMIYA	dc46897768	Close #7490: autosummary: Add `:caption:` option to autosummary directive	2020-04-16 23:04:57 +09:00
Matthias Geier	3baa6e09e2	FIXUP: move "versionadded"	2020-04-15 21:02:41 +02: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
Matthias Geier	c17f00c7a2	DOC: globaltoc_collapse, globaltoc_includehidden	2020-04-13 19:22:17 +02:00
Takeshi KOMIYA	1aca70cf80	Merge branch '3.x'	2020-04-13 23:36:49 +09:00
Takeshi KOMIYA	b2a601a33d	Merge branch '3.0.x' into 3.x	2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen	09f66c690b	Merge pull request #7468 from jakobandersen/c_namespace ... C, add scoping directives	2020-04-13 13:47:39 +02:00
Jakob Lykke Andersen	d4058eb67f	C, parse attributes	2020-04-13 13:43:26 +02:00
Daniel Fremont	8ee7d908f3	updated corresponding documentation	2020-04-12 12:06:14 -07:00
Jakob Lykke Andersen	bbc7b6cc54	C, add scoping directives	2020-04-12 14:13:54 +02:00
Tetsuo Koyama	4983a12f21	➕ 🇧🇬 🇮🇳 🇦🇱 🇷🇸	2020-04-12 19:04:42 +09:00
Takeshi KOMIYA	10d7760156	Fix #7410: Allow to suppress "circular toctree references detected" warnings	2020-04-12 15:25:35 +09:00
Rick Wertenbroek	df1b05a659	Update Instalation.rst - Docker sphinx-quickstart ... I suggest adding the -it option to the docker run command for sphinx-quickstart since it is an interactive command. Without interaction, the process will simply stop with the [Interrupted.] state after the first option ... > Separate source and build directories (y/n) [n]: [Interrupted.]	2020-03-25 11:18:18 +01:00
Takeshi KOMIYA	90fb44ee43	Merge branch '3.x'	2020-03-23 00:07:51 +09:00