Commit Graph

2818 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a5dadeb890 Fix #7418: std domain: duplication warning for glossary terms is case insensitive 2020-04-09 01:56:13 +09:00
Takeshi KOMIYA
50fd2ff510 Merge branch '3.x' 2020-03-28 23:07:02 +09:00
Takeshi KOMIYA
ba4510d01f doc: Hide changelog entries on ToC page 2020-03-28 22:01:32 +09:00
Tetsuo Koyama
f3aae09231
💝 Let's say thanks to all translator 2020-03-28 17:56:35 +09:00
Rick Wertenbroek
df1b05a659
Update Instalation.rst - Docker sphinx-quickstart
I suggest adding the -it option to the docker run command for sphinx-quickstart since it is an interactive command.
Without interaction, the process will simply stop with the [Interrupted.] state after the first option
...
> Separate source and build directories (y/n) [n]: 
[Interrupted.]
2020-03-25 11:18:18 +01:00
Takeshi KOMIYA
90fb44ee43 Merge branch '3.x' 2020-03-23 00:07:51 +09:00
Takeshi KOMIYA
ab75982be0 Fix document 2020-03-22 17:49:17 +09:00
Takeshi KOMIYA
a6c1cc2ace
Merge pull request #7352 from tk0miya/refactor_autosummary
Deprecate sphinx.ext.autosummary:process_autosummary_toc()
2020-03-22 17:41:33 +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
fe3782d2ed Deprecate sphinx.ext.autosummary:process_autosummary_toc()
The handler searches autosummary_toc node under root of document and
just under section nodes.  But that is already done in
ToctreeCollector.process_doc().  So it's no longer needed.
2020-03-21 21:44:59 +09:00
Takeshi KOMIYA
c7e590818a Merge branch '3.x' 2020-03-21 17:53:22 +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
Takeshi KOMIYA
69ae076864
Merge pull request #7317 from tk0miya/deprecate_get_documenters
Deprecate sphinx.ext.autodoc.get_documenters()
2020-03-19 01:30:05 +09:00
Tetsuo Koyama
7cc27eea3d
🔧 ⚠️ (#7292) 2020-03-18 16:18:11 +09:00
Jakob Lykke Andersen
385f7ed40e
Merge pull request #7319 from jakobandersen/c_revamp
C domain rewrite
2020-03-17 10:19:10 +01:00
Takeshi KOMIYA
ba99fae8a0
Merge pull request #7323 from mitya57/autogen-doc
Fix sphinx-autogen commandline in examples
2020-03-17 01:09:38 +09:00
Dmitry Shachnev
4fde2204a2 Fix sphinx-autogen commandline in examples 2020-03-16 17:43:38 +03:00
Takeshi KOMIYA
ee267f91f8
Merge pull request #7313 from tk0miya/7299_fix_todo_tutorial
Fix #7299: doc: Fix TODO tutorial
2020-03-16 22:45:23 +09: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
Takeshi KOMIYA
2202bff6b2 Deprecate sphinx.ext.autodoc.get_documenters() 2020-03-16 01:58:02 +09:00
Takeshi KOMIYA
d0cff3b4fc Deprecate sphinx.util.pycompat.execfile_() 2020-03-16 01:41:58 +09:00
Takeshi KOMIYA
a0bef9a86d
Merge pull request #7142 from septatrix/html-auxiliary-pygments-style
Add option for auxiliary pygments styles
2020-03-15 22:20:44 +09:00
Takeshi KOMIYA
8090e9040f Fix #7299: doc: Fix TODO tutorial 2020-03-15 18:33:41 +09:00
Septatrix
81fe5f8477 Remove html_pygments_dark_style option 2020-03-14 18:46:02 +01:00
Septatrix
a9cc5bf6f3 Add docs 2020-03-14 14:54:31 +01:00
Takeshi KOMIYA
9086ecdfff Merge branch '3.x' 2020-03-12 01:37:23 +09:00
Septatrix
97133d4bf0 Configure plantuml to generate svg files (fixes #7134) 2020-03-10 19:09:31 +01:00
Takeshi KOMIYA
e116613a3a Merge branch '3.x' 2020-03-10 01:15:52 +09:00
Daniel Hahler
6a396c7eb8 Enable intersphinx with Sphinx's documentation 2020-03-09 11:50:52 +01:00
Takeshi KOMIYA
3f21fd6041
Merge branch '3.x' into 7079_autodoc_typehints_description 2020-03-08 15:08:47 +09:00
Takeshi KOMIYA
d49bec1c67 py domain: Deprecate PyDecoratorMixin 2020-03-07 23:13:06 +09:00
Takeshi KOMIYA
3e0618ba3a Deprecate codes for docutils-0.13 or 0.14 2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
2bd7c19c7b Drop python 3.5 support 2020-03-07 18:06:39 +09:00
Takeshi KOMIYA
d517aa6c16 Close #7079: Make autodoc_typehints=description formal 2020-03-07 13:19:37 +09:00
Daniel Hahler
fbd111cfd1 doc/{Makefile,make.bat}: remove unused SPHINXPROJ
Appears to have been forgotten in f101bb661.
2020-03-07 03:43:49 +01:00
Takeshi KOMIYA
f13c546862 doc: Update docs 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
7c8b32a85d doc: Remove a mention to todo ext. from env-merge-info 2020-03-06 22:42:06 +09:00
Takeshi KOMIYA
cdbefb600f Support user defined LaTeX themes 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
a13ec4f41c Support LaTeX Theming; a set of document class settings (refs: #6672) 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
b5aa3ca1ac Merge branch '3.x' into 7005_kbd_for_latex 2020-03-05 23:47:07 +09:00
Takeshi KOMIYA
6e83f0dcb3 doc: fix a versionchnaged to correct one 2020-03-05 23:46:58 +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
754d04f80d Merge branch '2.4.x' into 3.x 2020-02-22 19:22:31 +09:00
Takeshi KOMIYA
9db38aadfd Fix #3106: domain: Register hyperlink target for index page automatically 2020-02-22 18:20:12 +09:00
Takeshi KOMIYA
bc14e8fd37 Merge branch '3.x' of github.com:sphinx-doc/sphinx into 3.x 2020-02-22 17:53:47 +09: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
2b70875f6a Merge branch 'drop_desc_signature_first' into 3.x 2020-02-22 17:39:56 +09:00
Takeshi KOMIYA
8987f3c031
Merge pull request #7062 from tk0miya/7032_no-scaled_link
Close #7032: html_scaled_image_link is disabled for individual image
2020-02-22 17:38:04 +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
5648b2eb88 Deprecate DescDirective 2020-02-22 12:15:20 +09:00
Vince Salvino
9fdc18d8de Adding documentation 2020-02-21 18:41:46 -05:00
Takeshi KOMIYA
a033d53c24 Close #7032: html_scaled_image_link is disabled for individual image 2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
4fc80e2816
Merge pull request #7168 from tk0miya/6346_update_doc
doc: Update usage/quickstart.rst to adjust latest quickstart
2020-02-18 00:58:47 +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
Takeshi KOMIYA
c97218cc97 doc: Fix file inclusion in recipe tutorial has been broken 2020-02-17 01:20:59 +09:00
Takeshi KOMIYA
379f52badf
Merge pull request #7154 from tk0miya/deprecate_Parser.app
Deprecate sphinx.parsers.Parser.app
2020-02-16 22:19:22 +09:00
Takeshi KOMIYA
954db2bd27 Merge branch '2.0' 2020-02-16 21:42:20 +09:00
Takeshi KOMIYA
9409db0771 Deprecate sphinx.parsers.Parser.app 2020-02-15 00:39:34 +09:00
Takeshi KOMIYA
baf4c7df23 Deprecate sphinx.util.inspect.getargspec() 2020-02-14 12:08:52 +09:00
Simon Willison
9b38e87468 Update copyright for 2020 2020-02-13 14:59:13 -08: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
6e0119526a Merge branch '2.0' 2020-02-09 16:21:32 +09:00
Takeshi KOMIYA
f751ab832e
Merge pull request #7113 from tk0miya/6327_apidoc_init.so
Fix #6327: apidoc: Support a python package consisted of __init__.so file
2020-02-09 10:50:45 +09:00
Takeshi KOMIYA
df3c0448dd Deprecate desc_signature['first'] 2020-02-09 00:58:42 +09: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
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
Takeshi KOMIYA
5640cf879f Merge branch '2.0' 2019-12-22 18:47:30 +09:00
Takeshi KOMIYA
6d6fe9da0d Add IndexDomain 2019-12-22 17:20:35 +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
00c30679cf Deprecate sphinx.io.FiletypeNotFoundError and get_filetype() 2019-12-16 01:45:02 +09:00
Takeshi KOMIYA
9b958f9525
Merge pull request #6925 from jdufresne/text-js
Remove redundant type="text/javascript" from <script> elements
2019-12-16 01:29:46 +09:00
Jon Dufresne
e6915baae8 Remove redundant type="text/javascript" from <script> elements
In HTML5, <script> elements default to MIME type text/javascript. The
HTML5 living standard and MDN recommend against including the attribute.

From https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type

> The HTML5 specification urges authors to omit the attribute rather
> than provide a redundant MIME type.

From https://html.spec.whatwg.org/#the-script-element

> Authors should omit the type attribute instead of redundantly setting
> it.
2019-12-15 07:52:40 -08: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
jfbu
30b26dd6a1 LaTeX: avoid quotes and TeX ligature replacements in PDF output
Refs: #6890

The comma character is not TeX-escaped because it is frequent in general
text and escaping it would make the LaTeX output larger for only dealing
with the problem of the LaTeX-ligature of ,, into a single character.
And one there is problem with the commas in options to Verbatim from
PygmentsBridge.

The hyphen character is escaped (not in ids and URIs!) to
\sphinxhyphen{} for both Unicode and non-Unicode engines. This is needed
to work around hyperref transforming -- and --- from section titles into
EN DASH resp. EM DASH in PDF bookmarks.

https://github.com/latex3/hyperref/issues/112

Note to expert LaTeX users: if Sphinx latex user with xelatex has

- turned off Smart Quotes for some reason,

- but does want TeX ligatures and thus overrode Sphinx
latex_elements['fontenc'] default (since #6888) to this effect,

then this should be added to LaTeX preamble:

    \def\sphinxhyphen#1{-}% (\protected is now not needed)
    \let\sphinxhyphenforbookmarks\sphinxhyphen
2019-12-15 14:19:50 +01: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
Olle Hynén Ulfsjöö
e35507ffd0 Add sphinxcontrib-beamer to list of extensions.
Change-Id: I943e42508cc8ca4e20c65803c1bca225195ddd0e
2019-12-09 11:06:23 +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