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
