451 Commits

Author	SHA1	Message	Date
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
Takeshi KOMIYA	ab75982be0	Fix document	2020-03-22 17:49:17 +09:00
Takeshi KOMIYA	8806cc257a	Merge pull request #7348 from tk0miya/7340_toctree_doc ... doc: Update about toctree directive	2020-03-22 16:28:36 +09:00
Takeshi KOMIYA	eccb9abe4a	doc: Update about toctree directive	2020-03-21 16:37:34 +09:00
Jakob Lykke Andersen	f12a7f1ae2	Simplify backslash stripping	2020-03-20 13:26:45 +01:00
Jakob Lykke Andersen	e0f779ba3d	Remove backslash stripping in domains. ... Adds several ways to reinstate the old behaviour. Fixes sphinx-doc/sphinx#6462	2020-03-20 12:25:31 +01:00
PythonCoderAS	c495b2a380	Correct minor typo	2020-03-18 21:49:41 -04:00
Jakob Lykke Andersen	b2ca906830	C, add expression parsing and expr role	2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen	815a9c657d	C, add new directives, fix xref lookup	2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen	0f49e30c51	C, initial rewrite	2020-03-15 19:49:16 +01:00
Septatrix	97133d4bf0	Configure plantuml to generate svg files (fixes #7134)	2020-03-10 19:09:31 +01:00
Takeshi KOMIYA	d517aa6c16	Close #7079: Make autodoc_typehints=description formal	2020-03-07 13:19:37 +09:00
Takeshi KOMIYA	f13c546862	doc: Update docs	2020-03-07 02:00:50 +09:00
Takeshi KOMIYA	cdbefb600f	Support user defined LaTeX themes	2020-03-06 22:11:25 +09:00
Takeshi KOMIYA	73e99ab88b	Update CHANGES and docs for PR #7064	2020-03-05 20:40:35 +09:00
Takeshi KOMIYA	93e519320b	Merge pull request #7227 from tk0miya/7217_docker ... Add a installation procedure for docker	2020-02-29 16:35:15 +09:00
Takeshi KOMIYA	e6f8ed063c	doc: Update installation	2020-02-29 16:22:55 +09:00
Takeshi KOMIYA	61b8edcb49	doc: Move docker section above "install from source"	2020-02-29 16:16:56 +09:00
Tetsuo Koyama	89490287e7	🆕 docker-sphinx ... Co-authored-by: tk0miya <i.tkomiya@gmail.com>	2020-02-25 12:47:14 +09:00
Tetsuo Koyama	e20430aee1	🆕 docker-sphinx	2020-02-24 16:04:53 +09:00
Tetsuo Koyama	e3fa132f2b	⬆️ doc/usage/installation.rst	2020-02-24 16:00:47 +09:00
Tetsuo Koyama	14d8cf636a	🆕 docker-sphinx	2020-02-24 15:41:27 +09:00
Takeshi KOMIYA	34255f6014	doc: Recommend to use py38-sphinx instead of py36-sphinx	2020-02-24 12:43:51 +09:00
Takeshi KOMIYA	448937eb4d	doc: Remove mention about py2	2020-02-24 12:43:00 +09:00
Takeshi KOMIYA	bfce1a71f6	Merge pull request #7087 from geographika/named-index-links ... Add name option for the index directive	2020-02-23 12:27:57 +09:00
sethg	b20d74f8a0	Review updates	2020-02-22 13:31:18 +01:00
Takeshi KOMIYA	b162273962	Merge pull request #7064 from tk0miya/7025_nosearch ... Close #7025: html search: full text search can be disabled via metadata	2020-02-22 17:53:01 +09:00
Takeshi KOMIYA	30b0361f9c	Close #7025: html search: full text search can be disabled via metadata	2020-02-22 17:34:44 +09:00
Takeshi KOMIYA	a033d53c24	Close #7032: html_scaled_image_link is disabled for individual image	2020-02-18 01:48:11 +09:00
sethg	28ad370343	Add option to docs	2020-02-16 21:37:41 +01:00
Takeshi KOMIYA	24b9efb65e	doc: Update usage/quickstart.rst to adjust latest quickstart	2020-02-17 02:12:27 +09:00
Neal McBurnett	b620a8a6cc	Fix typos ... bad quoting, better word usage.	2020-02-09 19:12:52 -07:00
Neal McBurnett	9b125cf8e9	Clarify documentation on use of doctest extension ... When I first read this section, I was mightily confused due to lack of context and the use of the passive voice. I think this phrasing clarifies the context and indicates more clearly what the documentation author does vs what the doctest extension and builder do. But I'm a newbie here, so please ensure that I got this right....	2020-02-09 16:59:39 -07:00
Takeshi KOMIYA	2e87ee85a2	Merge branch '2.0'	2020-02-09 00:57:53 +09:00
Takeshi KOMIYA	1e5342faa9	Merge pull request #7109 from sphinx-doc/6033_doc_for_tocdepth ... docs: Add a restriction note about tocdepth (refs: #6033)	2020-02-08 18:37:06 +09:00
Takeshi KOMIYA	f6acd061f3	docs: Add a restriction note about tocdepth (refs: #6033)	2020-02-07 23:59:20 +09:00
Matthias Geier	327778ca22	Disable arrow keys when a modifier key is pressed (#7089) ... * Disable arrow keys when a modifier key is pressed Closes #7088. * #7088 document key navigation option * add change note for #7088 Co-authored-by: Timotheus Kampik <timotheus.kampik@signavio.com>	2020-02-07 13:08:51 +01:00
Takeshi KOMIYA	0c0d037059	Merge pull request #7083 from tk0miya/update_docs ... doc: Make desc of gettext_additional_targets easy to read	2020-02-01 13:39:21 +09:00
Takeshi KOMIYA	423a7a7131	doc: Make desc of gettext_additional_targets easy to read	2020-02-01 13:12:32 +09:00
Takeshi KOMIYA	179a1f9cc2	py domain: Support type annotations for variables ... This adds ``:type:`` and ``:value:`` options to both ``py:data`` and ``py:attribute`` directives. It allows to describe its annotation in detail.	2020-02-01 12:58:27 +09:00
Takeshi KOMIYA	e7a0af807a	Merge branch '2.0'	2020-01-30 23:29:32 +09:00
Jakob Lykke Andersen	9fa23615ec	Fixes from review	2020-01-25 17:02:59 +01:00
Takeshi KOMIYA	5397664d42	Add a new extension: sphinx.ext.autodoc.typehints	2020-01-25 17:56:39 +09:00
Jakob Lykke Andersen	c084c3f124	Implement scoping for productionlist ... Fixes sphinx-doc/sphinx#3077	2020-01-22 22:32:30 +01:00
Takeshi KOMIYA	347e301727	Merge branch '2.0'	2020-01-19 22:47:02 +09:00
Takeshi KOMIYA	74a5f350a1	Add new event: autodoc-before-process-signature	2020-01-13 13:16:59 +09:00
Takeshi KOMIYA	f169560395	Merge pull request #6979 from tk0miya/6830_autodoc_private ... Close #6830: autodoc: consider a member private if docstring contains :private:	2020-01-11 15:14:52 +09:00
Takeshi KOMIYA	cad1f86dd8	Merge branch '2.0'	2020-01-11 02:56:58 +09:00
Ralf Gommers	659c66ad98	Update documentation of download role for addition of hash in subdir ... This was changed in gh-5377, but that forget the (now slightly misleading) documentation. Discovered in https://github.com/numpy/numpy.org/pull/14, where we were relying on download links being stable.	2020-01-07 13:06:16 +01:00
Takeshi KOMIYA	b968bb91e9	Close #6830: autodoc: consider a member private if docstring has "private" metadata	2020-01-04 13:28:07 +09:00
Takeshi KOMIYA	0319faf8f1	Merge branch '2.0'	2020-01-01 14:40:39 +09:00
Takeshi KOMIYA	2f36d792f3	Update CHANGES for PR #5230	2020-01-01 12:59:20 +09:00
Takeshi KOMIYA	e628afd5cd	Merge branch '2.0'	2020-01-01 11:39:46 +09:00
Takeshi KOMIYA	7851550cd8	doc: Fix ambiguous confval entries and references	2019-12-29 23:23:46 +09:00
Takeshi KOMIYA	18e25d680d	Close #6966: graphviz: Support `:class:` option	2019-12-27 22:38:10 +09:00
Takeshi KOMIYA	1fc4e8c251	Merge branch '2.0'	2019-12-25 22:44:12 +09:00
Takeshi KOMIYA	de9ee3e70a	doc: Fix sphinx.ext.duration will be added since 2.4.0	2019-12-25 22:43:56 +09:00
Takeshi KOMIYA	e83bb29789	Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass ... Close #5923: autodoc: allow not to document inherited members of specific super class	2019-12-22 16:30:56 +09:00
Takeshi KOMIYA	a209002b81	doc: Add examples for :inherited-members:	2019-12-22 16:05:45 +09:00
Takeshi KOMIYA	d47f38e22d	Merge branch '2.0'	2019-12-21 12:21:49 +09:00
Takeshi KOMIYA	29687a29f1	Close #6446: Add sphinx.ext.durations to inspect durations of build	2019-12-16 00:47:23 +09:00
Takeshi KOMIYA	712c20a3d9	Merge branch '2.0'	2019-12-16 00:05:35 +09:00
Damien Ayers	1a54a7229c	Fix documentation typo ... (cherry picked from commit 937c684960)	2019-12-13 23:27:04 +01:00
Damien Ayers	937c684960	Fix documentation typo	2019-12-13 12:33:02 +11:00
jfbu	2199a127e8	Typo (refs #6491)	2019-12-09 22:57:45 +01:00
Takeshi KOMIYA	7ec567b6d0	Merge branch '2.0'	2019-12-09 00:13:42 +09:00
Takeshi KOMIYA	9e40f2a603	doc: rewrite options for code-block by directive:option directive	2019-12-08 21:33:06 +09:00
Takeshi KOMIYA	d82e0bb5a5	doc: rewrite options for highlight by directive:option directive	2019-12-08 21:33:06 +09:00
Takeshi KOMIYA	fb9adbf0be	Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth ... Update docs about intersphinx and basic auth support	2019-12-03 01:42:37 +09:00
Takeshi KOMIYA	7292ab7eef	Merge branch '2.2.2' into 2.0	2019-12-03 01:19:02 +09:00
Santos Gallegos	46c68302be	Be more specific about the type of login	2019-12-02 11:07:17 -05:00
Takeshi KOMIYA	7c79a6b8d1	Close #5923: autodoc: allow not to document inherited members of specific super class	2019-12-01 12:51:28 +09:00
Takeshi KOMIYA	15c266c445	Merge branch '2.0'	2019-11-30 21:52:42 +09:00
Takeshi KOMIYA	82a6048f12	Fix typo	2019-11-28 23:31:08 +09:00
Santos Gallegos	f7c1e9190a	Linter	2019-11-27 15:38:26 -05:00
Santos Gallegos	a72d8f6808	Update docs about intersphinx and basic auth support ... This was added in #2089 but the docs don't mention it.	2019-11-27 15:23:52 -05:00
Takeshi KOMIYA	1cc1481771	Merge pull request #6866 from tk0miya/napoleon_doc_fix ... doc: URL of numpydoc has changed	2019-11-27 01:25:33 +09:00
Takeshi KOMIYA	82b2b1752a	doc: URL of numpydoc has changed	2019-11-27 00:12:32 +09:00
Takeshi KOMIYA	9bd64e4e2a	Merge pull request #6862 from tk0miya/6854_update_supported_languages_list ... Update supported languages (refs: #6854)	2019-11-27 00:04:22 +09:00
jfbu	dc53404d48	Fix markup issue in our docs	2019-11-26 14:22:17 +01:00
jfbu	d398959230	Fix typo in docs	2019-11-26 14:11:40 +01:00
Takeshi KOMIYA	995dfa4e73	Merge pull request #6816 from jonashaag/linkcheck-auth ... Add linkcheck_auth option	2019-11-26 01:29:30 +09:00
Takeshi KOMIYA	1faf14d411	Update supported languages (refs: #6854)	2019-11-26 01:22:14 +09:00
Takeshi KOMIYA	6de29cdb84	Merge pull request #6854 from jfbu/doc_mention_Greek_as_supported_language ... DOC: add Greek to list of supported languages	2019-11-26 00:56:34 +09:00
Jonas Haag	df2f80c755	Add linkcheck_auth option	2019-11-25 09:53:45 +01:00
jfbu	70f087990b	DOC: add Greek to list of supported languages	2019-11-22 19:15:59 +01:00
Takeshi KOMIYA	c65243325c	Merge branch '2.0' into 6798_autosummary_emits_skip_member_event	2019-11-21 00:45:57 +09:00
Sylvestre Ledru	3aef93c4a3	Fix the URL to https://pygments.org/docs/lexers.html	2019-11-20 14:49:15 +01:00
Takeshi KOMIYA	c6f0eb215a	Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental)	2019-11-17 17:37:48 +09:00
Takeshi KOMIYA	6644830941	Merge branch '2.0'	2019-11-17 14:24:04 +09:00
Joe	1fd7176f89	Fix link to pygments lexer	2019-11-16 18:11:14 -08:00
Takeshi KOMIYA	66c3dd3adb	Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file	2019-11-16 18:19:31 +09:00
Tetsuo Koyama	7fbd9c02d0	🎨 Fixed issue #6789	2019-11-04 20:28:24 +09:00
Takeshi KOMIYA	32763520a3	Close #1331: Change default User-Agent header	2019-10-27 02:05:33 +09:00
Takeshi KOMIYA	a6a2a59ab0	Merge branch '2.0'	2019-10-20 13:43:30 +09:00
Takeshi KOMIYA	cb22be80c2	Merge branch '2.2.1' into 2.0	2019-10-20 13:42:10 +09:00
Takeshi KOMIYA	a950df1908	Close #6729: HTML theme: agogo theme now supports rightsidebar option	2019-10-14 14:26:33 +09:00
jfbu	7be68b7c4b	Add latexpdf support for Greek as main language (via xelatex use) ... Closes: #6710	2019-10-01 10:27:43 +02:00
Takeshi KOMIYA	01f8dad160	Merge branch '2.0'	2019-08-19 00:37:30 +09:00
ExplorerLog	edff2824e9	Update configuration.rst ... Add a comma	2019-08-16 16:29:29 +08:00
jfbu	4ae5414ee5	Update our docs for imgmath_latex (refs: #6610)	2019-08-03 12:00:24 +02:00
jfbu	47cd262b3e	Merge branch '2.0'	2019-08-01 18:30:48 +02:00
jfbu	7c59e44eaa	Fix version changed info in our document for imgmath	2019-08-01 18:24:28 +02:00
jfbu	da3763170e	Reorganize documentation of the imgmath configuration variables	2019-08-01 17:52:28 +02:00
jfbu	505ff622c2	More robust code for getting saved "depth" of svg inline math snippet	2019-08-01 17:52:28 +02:00
jfbu	1adf12bfa7	Make imgmath_use_preview work also for svg output	2019-08-01 17:52:28 +02:00
Timotheus Kampik	0662a3ecd6	#6503 document meta directive (#6562) ... #6503 document meta directive The `meta` directive has partly Sphinx-specific behavior and hence needs to be documented	2019-07-08 22:48:41 +02:00
woutdenolf	9dc9b8754d	Merge with master and address code review	2019-07-08 08:29:23 +02:00
Takeshi KOMIYA	4af90fcf75	Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file	2019-07-07 16:18:49 +09:00
Dull Bananas	e24709c2df	Clarify Windows installation	2019-07-05 18:41:22 -07:00
Takeshi KOMIYA	c18dcf08f9	Merge branch '2.0'	2019-06-30 01:08:48 +09:00
Takeshi KOMIYA	828beb12e0	doc: Update document for :annotation: option (refs: #6495)	2019-06-29 18:43:30 +09:00
Takeshi KOMIYA	5d42659e33	Merge branch '2.0'	2019-06-15 23:39:44 +09:00
woutdenolf	ec8656bd27	[autosummary] remove recursion limit and module/package separation	2019-06-02 16:26:40 +02:00
Takeshi KOMIYA	ce2f9c2b94	Close #5124: graphviz: :graphviz_dot: option is renamed to :layout:	2019-06-02 21:33:34 +09:00
Takeshi KOMIYA	c4f44bdd22	Merge branch '2.0'	2019-06-02 21:17:38 +09:00
Takeshi KOMIYA	1303ea7cdf	docs: Use directive:option in extensions/graphviz	2019-06-02 18:18:55 +09:00
Takeshi KOMIYA	5da74898c3	Merge branch '2.0'	2019-06-02 01:09:09 +09:00
Takeshi KOMIYA	4c19ab7058	Merge commit '54d5fcfaebc3364044761d30c0fed6bd4d3052c3'	2019-06-02 01:02:54 +09:00
Takeshi KOMIYA	91fceb4b5f	Merge branch '2.0.2' into 2.0	2019-06-02 00:58:46 +09:00
woutdenolf	4fb58b2146	[autosummary] doclint violation	2019-06-01 13:08:23 +02:00
woutdenolf	140ae00baa	Merge branch 'master' into feature-autosummary-packages	2019-06-01 12:42:28 +02:00
Takeshi KOMIYA	54d5fcfaeb	Merge pull request #6416 from tk0miya/2310_force_highlighting ... Add :force: option to code directives	2019-06-01 14:17:53 +09:00
Takeshi KOMIYA	e001d358d0	Add :force: option to code directives	2019-06-01 13:42:57 +09:00
Takeshi KOMIYA	c6d840d95a	doc: Change wording for contents directive (refs: #6265)	2019-06-01 11:27:38 +09:00
Takeshi KOMIYA	ce3c5735cd	Merge branch '2.0'	2019-06-01 01:45:47 +09:00
Takeshi KOMIYA	2afba22cee	Merge pull request #6397 from tk0miya/6361_autodoc_typehints ... Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature	2019-06-01 01:07:37 +09:00
gilch	e7239053b7	Grammar corrections	2019-05-29 19:41:45 -06:00
Takeshi KOMIYA	d6063ff35b	doc: Fold lines by 80 columns	2019-05-30 01:07:05 +09:00
Takeshi KOMIYA	b9d7239d90	Merge branch '2.0'	2019-05-29 00:51:25 +09:00
Takeshi KOMIYA	9b2423c5bb	doclinter: restrict by 90 columns	2019-05-26 10:53:53 +09:00
Takeshi KOMIYA	0ea380eddd	Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature	2019-05-26 00:35:24 +09:00
Takeshi KOMIYA	3105feec80	doc: Update with rst:directive:option directive	2019-05-20 00:26:28 +09:00
Takeshi KOMIYA	557d8d140e	Merge pull request #6365 from tk0miya/refactor_py_domain ... Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc	2019-05-19 23:46:34 +09:00
woutdenolf	1a67b87910	Merge branch 'master' into feature-autosummary-packages	2019-05-18 14:42:34 +02:00
Takeshi KOMIYA	279223065b	Merge branch '2.0' into master	2019-05-17 01:24:45 +09:00
Gibson Fahnestock	6f7cb4da94	autosectionlabel: add type for suppress_warnings ... This sets the subtype to the filename, which means that you can suppress warnings for individual paths. For example for the following warning: ``` path/to/file.rst:5547: WARNING: duplicate label path/to/file:label, other instance in /path/to/file.rst ``` You would add this to `config.py` to suppress all warnings: ```python extensions = [ 'sphinx.ext.autosectionlabel', ] autosectionlabel_prefix_document = True suppress_warnings = [ 'autosectionlabel.*', ] ``` To suppress warnings for the individual file path you would do: ```python suppress_warnings = [ 'autosectionlabel.path/to/file', ] ``` Fixes: https://github.com/sphinx-doc/sphinx/issues/6371	2019-05-15 19:30:46 +01:00
Adrián Chaves	e84ba7f78a	Support coverage_ignore_pyobjects in the coverage builder	2019-05-15 12:23:05 +02:00
Takeshi KOMIYA	64eacb30a8	Fix modname of HTMLHelpBuilder	2019-05-15 00:08:27 +09:00
Takeshi KOMIYA	358e582490	Add :abstractmethod: option to py:method directive (refs: #6138)	2019-05-15 00:00:51 +09:00
Takeshi KOMIYA	f63abac2ca	Merge branch '2.0'	2019-05-13 22:03:26 +09:00
Takeshi KOMIYA	416426dfb7	Merge pull request #6356 from tk0miya/foldlines ... Add utils/doclinter.py; a documenter linter for Sphinx	2019-05-13 14:39:01 +09:00
Takeshi KOMIYA	ca605c7437	Add :type: option for rst:directive:option directive	2019-05-13 14:14:14 +09:00
Takeshi KOMIYA	4307dec3ac	Add rst:directive:option directive	2019-05-13 13:55:56 +09:00
Takeshi KOMIYA	fa00458f4f	docs: Fold lines by 80 chars	2019-05-12 17:57:38 +09:00
Takeshi KOMIYA	a142a654fc	Add :property: option to py:method directive	2019-05-12 15:53:39 +09:00
Takeshi KOMIYA	37a5736a1f	Merge branch '2.0'	2019-05-06 21:09:43 +09:00
jfbu	48ad83d061	Reorganize documentation of the imgmath configuration variables	2019-04-24 12:30:18 +02:00