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
dee8b9eddb
Fix #6327 : apidoc: Support a python package consisted of __init__.so file
2020-02-08 18:11:48 +09:00
Takeshi KOMIYA
9d301e5b81
refactor: apidoc.shall_skip()
2020-02-08 17:59:29 +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
7c90a05144
Merge branch '2.0' into 6772_apidoc_quiet_mode
2020-02-02 23:59:52 +09: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
7d6374d983
testing: Add Path.read_text() and Path.read_bytes()
...
To migrate pathlib.Path in future, compatibile methods are needed
for our Path class.
2020-02-01 11:45:47 +09:00
Takeshi KOMIYA
41032572a5
Merge branch '2.0'
2020-02-01 11:17:03 +09:00
Takeshi KOMIYA
aced2be1fb
apidoc: Add `-q` option for quiet mode (refs: #6772 )
2020-02-01 00:30:09 +09:00
Takeshi KOMIYA
b73cc5652a
Update deprecation list
2020-01-31 01:59:24 +09:00
Takeshi KOMIYA
52afc79e1f
Merge branch '2.0' into refactor_latex
2020-01-31 01:18:57 +09:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
67fefcc6f9
Merge branch '2.0' into 6418_autodoc_typehints_description
2020-01-30 23:19:45 +09:00
Jakob Lykke Andersen
9fa23615ec
Fixes from review
2020-01-25 17:02:59 +01:00
Takeshi KOMIYA
045630ec85
Deprecate sphinx.util.inspect:safe_getmembers()
2020-01-25 23:21:33 +09:00
Takeshi KOMIYA
5397664d42
Add a new extension: sphinx.ext.autodoc.typehints
2020-01-25 17:56:39 +09:00
Takeshi KOMIYA
2e22e96061
Add new event: :event:object-description-transform
2020-01-25 17:12:41 +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
38ef16945e
Merge pull request #7021 from tk0miya/6754_docs_for_nodes_in_confpy
...
Warn about dangers of inheriting nodes in conf.py (2)
2020-01-13 15:03:41 +09:00
Takeshi KOMIYA
aafaa92237
doc: Use attention for notes about nodes in conf.py
2020-01-13 14:51:04 +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
Takeshi KOMIYA
6fa592f111
Merge pull request #7002 from tk0miya/refactor_Signature2
...
refactor: Add sphinx.util.inspect.signature()
2020-01-11 01:24:09 +09:00
Jesse Tan
7c1b673076
Add LaTeX styling hook for :kbd: role
2020-01-09 16:35:40 +01:00
Takeshi KOMIYA
5867416612
refactor: Add sphinx.util.inspect.signature()
...
As a successor of sphinx.util.inspect.Singnature, this adds
signature() function behaves like `inspect.signature()`. It is
very similar to way of python's inspect module.
In addition, this also adds stringify_annotation() helper to
sphinx.util.inspect module. With these two functions, we can move
to python's Signature object to represent function signatures
perfectly. It's natural design for python developers than ever.
2020-01-09 00:32:07 +09:00
Takeshi KOMIYA
af2a3c0dde
Merge branch '2.0'
2020-01-08 01:37:53 +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
05daa3c7ce
Add sphinx.util.typing:stringify() to represent annotations as string
2020-01-05 01:13:27 +09: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
7123f4038a
Fix #6559 : Wrong node-ids are generated in glossary directive
2020-01-02 22:03:39 +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
c358e04b09
Close #6558 : glossary: emit a warning for duplicated glossary entry
2019-12-29 22:31:36 +09:00
Takeshi KOMIYA
8dc3315ce5
Deprecate sphinx.roles:Index and make a copy to sphinx.domains.index
2019-12-29 19:12:58 +09:00
Takeshi KOMIYA
4f83793fd0
Move sphinx.directives.other:Index to sphinx.domains.index
2019-12-29 18:21:26 +09:00
Takeshi KOMIYA
9656b6d4dd
Merge pull request #6967 from tk0miya/6966_graphviz_class
...
Close #6966 : graphviz: Support ``:class:`` option
2019-12-29 00:25:05 +09:00
Takeshi KOMIYA
ff9e5e6dbd
doc: Sort deprecated list alphabetically
2019-12-28 19:37:43 +09:00
Takeshi KOMIYA
3ddbd73f49
refactor: latex: Deprecate settings.* attributes based on latex_documents
2019-12-27 22:46:16 +09:00
Takeshi KOMIYA
18e25d680d
Close #6966 : graphviz: Support `:class:` option
2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
c8074b4a5d
Deprecate sphinx.util:detect_encoding() and ModuleAnalyzer.encoding
2019-12-27 22:08:32 +09:00
Takeshi KOMIYA
7581ee1084
Deprecate sphinx.util:get_module_source()
2019-12-27 01:57:39 +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
