415 Commits

Author	SHA1	Message	Date
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
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
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	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
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	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
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
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	b1554ae25a	doc: Fix wrong version info	2020-05-10 01:12:39 +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	87308d9607	Close #7143: py domain: Add :final: option to py:*: directives	2020-04-28 01:24:29 +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