2920 Commits

Author	SHA1	Message	Date
Takeshi KOMIYA	59e0746cb5	doc: Remove intro.rst (ref: #7751)	2020-05-31 12:06:45 +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
Takeshi KOMIYA	6be72c6ed2	Merge pull request #7752 from stephenfin/doc/latex-rework ... [doc] Rework "latex" document	2020-05-31 01:09:23 +09:00
Stephen Finucane	f3360e6922	docs: Fix typo, replace field lists with paragraphs ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:43:05 +01:00
Stephen Finucane	aaf2dafd63	docs: Compare docutils with Sphinx ... Add an FAQ entry comparing the two. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:38:12 +01:00
Stephen Finucane	e4e5c509b6	doc: Rework "templating" documents ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:29:13 +01: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	52bb0b02bb	docs: Fix a typo and some indentation ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:23:36 +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
Jakob Lykke Andersen	ff7545a191	Allow NoUri from 'missing-reference' handlers. ... Also extend documentation of 'missing-reference'.	2020-05-17 12:34:33 +02:00
Takeshi KOMIYA	d47427e94f	Merge pull request #7647 from tk0miya/fix_versionchanged ... doc: Fix wrong version info	2020-05-10 16:03:01 +09:00
Takeshi KOMIYA	b1554ae25a	doc: Fix wrong version info	2020-05-10 01:12:39 +09:00
Takeshi KOMIYA	891c659ced	Deprecate sphinx.util:rpartition()	2020-05-09 22:00:04 +09:00
Takeshi KOMIYA	1ba671a677	Deprecate ignore parameter for Documenter.get_doc()	2020-05-03 01:59:47 +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	4eafda8588	Merge pull request #7546 from tk0miya/4030_autosummary_context ... Close #4030: autosummary: Add autosummary_context	2020-04-27 02:01:34 +09:00
Takeshi KOMIYA	037fe96dc1	Close #4030: autosummary: Add autosummary_context	2020-04-25 11:15:43 +09:00
Takeshi KOMIYA	e5192ba48b	refactor: AutosummaryRender	2020-04-25 01:25:00 +09:00
Takeshi KOMIYA	0374d217d4	refactor: Deprecate unused parameters	2020-04-23 22:54:53 +09:00
Takeshi KOMIYA	931bfcca88	refactor: autosummary: Change first argument for AutosummaryRenderer	2020-04-23 22:51:23 +09:00
Takeshi KOMIYA	ebfa8dbf2a	Merge pull request #7538 from tk0miya/7535_autogen_crashes_on_inherited_template ... Fix #7535: sphinx-autogen: crashes when custom template uses inheritance	2020-04-23 21:46:06 +09:00
Takeshi KOMIYA	61b823ad10	refactor: Deprecate unused parameters	2020-04-23 02:25:58 +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	e1c7e9d481	Fix #7534: docs: Big vertical whitespace rendered in official doc	2020-04-22 23:37:44 +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	b5066cf48f	Merge pull request #7513 from tk0miya/7488_docs ... Fix #7488: Update docs	2020-04-20 00:47:34 +09:00
Takeshi KOMIYA	68375c92f2	Fix #7488: Update docs	2020-04-19 23:01:57 +09:00
Takeshi KOMIYA	4627742cb3	doc: Fix html_use_opensearch of sphinx-doc.org	2020-04-19 01:50:38 +09:00
Matthias Geier	fc78f09441	DOC: Use html_baseurl	2020-04-17 17:01:48 +02: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	b2a601a33d	Merge branch '3.0.x' into 3.x	2020-04-13 23:36:10 +09:00