2784 Commits

Author	SHA1	Message	Date
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	dce45413e6	Merge pull request #7762 from tk0miya/7247_linkcheck_request_headers ... Close #7247: linkcheck: Add linkcheck_request_headers	2020-06-05 01:17:31 +09:00
Stephen Finucane	227bbf6559	docs: Expand organization document ... Provide some guidance on how one can become a core developer and explain the different types of contribution one can make. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 12:13:31 +01:00
Stephen Finucane	fa5fadc3f3	docs: Tweaks to code of conduct ... - Replace unicode quotes with ascii, since Sphinx will automatically translate these for us - Move the header to the root document - Use an admonition instead of a header for the attribution section Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 12:10:24 +01:00
Stephen Finucane	6b480c97b2	docs: Rework contributing document, re-add CONTRIBUTING ... Reorder this to flow a little better and re-add the CONTRIBUTING document, which now simply points to the main documentation. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 12:10:21 +01:00
Stephen Finucane	d3021f644f	docs: Add contributing document ... This completes the migration from the CONTRIBUTING document to the new in-tree contributing guide. The CONTRIBUTING document itself is temporarily removed so that git will correctly mark the document as having been moved. A future change will re-add this document as well as rework the new contributing document. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 12:08:34 +01:00
Stephen Finucane	a33483f154	docs: Add release process document ... This is based on content extracted from the CONTRIBUTING document. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 11:43:44 +01:00
Stephen Finucane	6b19678253	docs: Add organization overview ... Provide an introduction to how the Sphinx team is organized. This will be expanded upon in a future change. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 11:43:44 +01:00
Stephen Finucane	6a5921d7b2	docs: Add "project internals" guide ... This is modelled off Django's guide of the same name [1]. In summary, this will contain most of the information previously found in the CONTRIBUTING document. For now, we move just the code of conduct and authors documents. Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-06-02 11:43:44 +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	212fd67b9f	Merge pull request #7755 from stephenfin/doc/docutils-vs-sphinx ... [doc] Compare docutils and Sphinx	2020-05-31 12:21:16 +09:00
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