Commit Graph

3136 Commits

Author SHA1 Message Date
Takeshi KOMIYA
dc46897768 Close #7490: autosummary: Add `:caption:` option to autosummary directive 2020-04-16 23:04:57 +09:00
Matthias Geier
3baa6e09e2 FIXUP: move "versionadded" 2020-04-15 21:02:41 +02:00
Takeshi KOMIYA
19d5d8d75c Fix #7477: imgconverter: Invoke "magick convert" command on Windows 2020-04-15 23:23:28 +09:00
Eric Wieser
0d7451c23d Add support for :meta public:
A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes.

Rejected spellings include:
* `:meta not-private:`
* `:meta private: False`
2020-04-14 08:41:45 +01:00
Matthias Geier
c17f00c7a2 DOC: globaltoc_collapse, globaltoc_includehidden 2020-04-13 19:22:17 +02:00
Takeshi KOMIYA
1aca70cf80 Merge branch '3.x' 2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
b2a601a33d Merge branch '3.0.x' into 3.x 2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
09f66c690b
Merge pull request #7468 from jakobandersen/c_namespace
C, add scoping directives
2020-04-13 13:47:39 +02:00
Jakob Lykke Andersen
d4058eb67f C, parse attributes 2020-04-13 13:43:26 +02:00
Daniel Fremont
8ee7d908f3 updated corresponding documentation 2020-04-12 12:06:14 -07:00
Jakob Lykke Andersen
bbc7b6cc54 C, add scoping directives 2020-04-12 14:13:54 +02:00
Takeshi KOMIYA
f978490dfe
Merge pull request #7465 from tkoyama010/patch-1
 🇧🇬 🇮🇳 🇦🇱 🇷🇸
2020-04-12 19:22:30 +09:00
Tetsuo Koyama
4983a12f21
🇧🇬 🇮🇳 🇦🇱 🇷🇸 2020-04-12 19:04:42 +09:00
Takeshi KOMIYA
53f0d4e646 Deprecate: The module argument of find_autosummary_in_docstring() 2020-04-12 18:14:16 +09:00
Takeshi KOMIYA
bbd673e253
Merge branch '3.x' into 7410_suppress_circular_toctree_warning 2020-04-12 15:41:25 +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
eb46db036f doc: Fix indentation 2020-04-11 15:44:07 +09:00
Takeshi KOMIYA
fd7c1d76b6 Merge branch '3.0.x' into 3.x 2020-04-11 00:04:45 +09:00
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
Takeshi KOMIYA
d82e0bb5a5 doc: rewrite options for highlight by directive:option directive 2019-12-08 21:33:06 +09:00
jfbu
73a2228c87 Update 'fontenc' latex_elements key documentation 2019-12-07 12:27:21 +01: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
Takeshi KOMIYA
cba9ff9ce2
Merge pull request #6841 from tk0miya/4186_uplatex
Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental)
2019-11-21 00:42:21 +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
f3469bcc8f Make escape() and hlescape() as public APIs of texescape 2019-11-16 19:42:06 +09:00
Takeshi KOMIYA
5f559fbb98 Deprecate sphinx.util.texescape.tex_escape_map 2019-11-16 18:34:48 +09:00
Takeshi KOMIYA
66c3dd3adb Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file 2019-11-16 18:19:31 +09:00
Takeshi KOMIYA
8f554c465d
Merge pull request #6802 from tk0miya/6781_gettext_template
gettext: Use template file to generate message catalog
2019-11-15 02:33:09 +09:00
Takeshi KOMIYA
399f773d9d gettext: Use template file to generate message catalog 2019-11-08 00:36:57 +09:00
jfbu
a550c7075f LaTeX: Allow linebreaks at \ (in literals, code-blocks, parsed-literal)
Default configuration is to allow the linebreak after the backslash.
It is possible at user side via 'preamble' key and some LaTeX code
to allow the linebreak before the backslash, but each of inline-literal,
code-block, and parsed-literal has its more or less cumbersome way for
that.

Closes: #6000, #6001

This commit handles only the \ character, which had been left aside
by accident so far. Inline-literals could break at more characters
but this is not yet done in this commit. In this context, in future
it could be useful to modify sphinx.util.texescape to use mark-up
such as \sphinxtextbackslash rather than naked \textbackslash and
similarly for some other characters. This could then be used to
allow linebreaks even in regular text paragraphs.
2019-11-06 18:59:09 +01:00
Takeshi KOMIYA
b4cd34c8f4
Merge branch '2.0' into 1331_useragent 2019-11-05 22:58:33 +09:00
Takeshi KOMIYA
4ec563fcff Close #6762: latex: Allow to load additonal LaTeX packages 2019-11-05 22:25:41 +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
Takayuki SHIMIZUKAWA
4edd69566e
fix long line for doclinter 2019-10-26 17:21:57 +09:00
Takayuki SHIMIZUKAWA
c57325d776
doc: remove required version of the external libraries 2019-10-26 16:08:41 +09:00
Takayuki SHIMIZUKAWA
71334def42
doc: avoid font-size when :mod: role in headings 2019-10-26 15:35:06 +09:00
Sviatoslav Sydorenko
842fbfa1e8
Warn about dangers of inheriting nodes in conf.py
Closes #6751
2019-10-22 14:54:57 +02: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
Takeshi KOMIYA
0000e7fd4a
Merge pull request #6682 from Jacob-Stevens-Haas/patch-1
Get rid of comma in sphinx-apidoc documentation
2019-10-12 22:51:01 +09:00
Takeshi KOMIYA
7faeb793e2 Close #6658: Add CODE_OF_CONDUCT (#6661)
* Close #6658: Add CODE_OF_CONDUCT

* #6658 refine CoC

* Base on Django CoC: https://www.djangoproject.com/conduct/
* Simplify: we are a smaller project and can be more concise
* Add to ToC
* Link from README
* Link from index page
2019-10-06 16:41:37 +02:00
Takeshi KOMIYA
e8925e78ca Merge branch '2.0' 2019-10-06 18:41:32 +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
Jacob Stevens-Haas
9d239a64fc
Get rid of comma in sphinx-apidoc documentation
#6674 
Nixing the comma in `EXCLUDE PATTERN, ...` because it's not supposed to be there.  See the issue for the research.
2019-09-01 17:08:13 -07:00
Takeshi KOMIYA
21cd1c2ef5 refactor: SphinxStandaloneReader should not hold an application object 2019-08-20 21:45:50 +09: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
1c152d249c Merge branch '2.0' 2019-07-07 18:50:58 +09:00
Takeshi KOMIYA
4af90fcf75 Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file 2019-07-07 16:18:49 +09:00
Takeshi KOMIYA
10883c2824 docs: Update FAQ for github pages 2019-07-07 16:08:54 +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
b325a1de2b Merge branch '2.0' 2019-06-21 12:47:02 +09:00
Takeshi KOMIYA
a0b4d09b1b Close #5602: apidoc: Add `--templatedir` option 2019-06-16 13:39:21 +09:00
Takeshi KOMIYA
564d23be7a
Merge pull request #6467 from tk0miya/refactor_math
refactor: Add data accessors to MathDomain
2019-06-15 23:48:57 +09:00
Takeshi KOMIYA
5d42659e33 Merge branch '2.0' 2019-06-15 23:39:44 +09:00
Takeshi KOMIYA
d2f0c83568
Merge pull request #6433 from tk0miya/refactor_todo2
refactor todo extension with Domain
2019-06-15 23:12:03 +09:00
Takeshi KOMIYA
9b0f415e21 refactor: Add data accessors to MathDomain 2019-06-15 23:05:45 +09:00
Takeshi KOMIYA
05c1c4c33a
Merge pull request #6430 from tk0miya/5124_graphviz_layout_option
Close #5124: graphviz: :graphviz_dot: option is renamed to :layout:
2019-06-15 16:46:48 +09:00
Takeshi KOMIYA
f6dfab33d2
Merge branch '2.0' into refactor_todo2 2019-06-15 16:45:17 +09:00
Takeshi KOMIYA
649ebea438 autosummary: deprecate info and warn arguments for generate_autosummary_docs() 2019-06-10 13:45:28 +09:00
Takeshi KOMIYA
8fd817d174 refactor: todo: Add TodoListProcessor to expand todolist nodes 2019-06-03 00:17:29 +09:00
Takeshi KOMIYA
9abb4820b1 refactor: todo: Add TodoDomain to collect todo nodes 2019-06-02 23:41:39 +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
1769280348
Merge pull request #6420 from tk0miya/6405_wrong_link
Fix #6405: docs: wrong link
2019-06-01 01:42:52 +09:00
Takeshi KOMIYA
c74296fa50 Fix #6405: docs: wrong link 2019-06-01 01:24:57 +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
eb76799a89 doc: Fold lines by 80 columns 2019-05-29 10:43:59 +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
38aacdffdb
Merge pull request #6392 from tk0miya/6348_hieroglyph
doc: Remove hieroglyph temporarily (refs: #6348)
2019-05-23 10:54:28 +09:00
Takeshi KOMIYA
1e221da332 doc: Remove hieroglyph temporarily (refs: #6348) 2019-05-23 10:32:18 +09:00
Takeshi KOMIYA
44f03e2c75 docs: Update URL of writethedocs 2019-05-21 22:16:15 +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
c81ae00430
Merge pull request #6369 from tk0miya/refactor_apidoc_module_join
refactor: apidoc: Replace makename() by module_join()
2019-05-15 00:36:21 +09:00
Takeshi KOMIYA
7c8b1ad900 refactor: apidoc: Replace makename() by module_join() 2019-05-15 00:18:00 +09: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
Brian Skinn
0dbdae3159 Add %O% option to make.bat templates; update docs
The make.bat_t and make.bat.new_t templates now pass %O% as well as
%SPHINXOPTS% to `sphinx-build`, in parity with Makefile.new_t.

The sphinx-build documentation page was updated to explicitly note
$(O) and %O% as shortcut variables.

Closes #6323, per the comment thread discussion.
2019-05-13 10:44:27 -04: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
Takeshi KOMIYA
fa560ebf95 apidoc: Deprecate unused functions 2019-05-04 18:42:22 +09:00
Takeshi KOMIYA
b0d070c857
Merge pull request #6333 from juh2/patch-1
adding German book about Sphinx
2019-05-03 23:19:21 +09:00
SuryaGrandhi
1f77b95de6
Removing broken links
Using sphinx with Read the Docs, the Getting Started link has been updated.
2019-05-03 15:26:40 +05:30
juh
6be9556904
adding German book about Sphinx
Adding a link to the authors bookpage.
2019-05-02 11:49:23 +02:00
jfbu
48ad83d061 Reorganize documentation of the imgmath configuration variables 2019-04-24 12:30:18 +02:00
jfbu
ea28bd9fb0 More robust code for getting saved "depth" of svg inline math snippet 2019-04-24 11:56:19 +02:00
Jon Dufresne
ee23a29b3c Deprecate EpubBuilder.esc() in favor of stdlib html.escape()
Available since Python 3.2.

https://docs.python.org/3/library/html.html#html.escape
2019-04-23 19:34:55 -07:00
jfbu
3edcff7952 Make imgmath_use_preview work also for svg output 2019-04-23 15:13:21 +02:00
jfbu
65ac90773d Merge branch '2.0' 2019-04-23 14:48:17 +02:00
Takeshi KOMIYA
e0abb10792 Fix #4777: Add :async: option to py:function and py:method directives 2019-04-23 01:40:37 +09:00
Takeshi KOMIYA
a285220778
Merge branch '2.0' into refactor_py_domain2 2019-04-23 01:16:42 +09:00
Takeshi KOMIYA
e9e8fd264b
Merge pull request #6308 from tk0miya/imgmath_template
imgmath: Use template file for LaTeX
2019-04-19 13:13:37 +09:00
jfbu
6009140f22 Fix a dvisvgm link in docs and add preview-latex link 2019-04-17 10:07:30 +02:00
Takeshi KOMIYA
06f86b0639 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-16 14:06:36 +09:00
Takeshi KOMIYA
15bc5a32bb
Merge pull request #6260 from tk0miya/refactor_events
Make EventManager portable
2019-04-16 14:04:54 +09:00
Takeshi KOMIYA
aabeb71123 imgmath: Use template file for LaTeX 2019-04-16 01:38:31 +09:00
Alex Sergeev
98691baf85 Address comments 2019-04-14 10:47:50 -10:00
Takeshi KOMIYA
efc3405c6f Merge branch '2.0' 2019-04-14 19:35:33 +09:00
Alex Sergeev
4bad5bd419 Address feedback 2019-04-13 20:54:20 -10:00
Takeshi KOMIYA
331594e2ca Add :classmethod: and :staticmethod: options to py:method directive 2019-04-13 23:14:59 +09:00
Takeshi KOMIYA
6af3896103 Add PyFunction and PyVariable; directives for python functions and variables 2019-04-13 20:26:07 +09:00
jfbu
a46d4c9bca Improve documentation formatting for Sphinx LaTeX environments 2019-04-12 19:30:31 +02:00
jfbu
f8f4ce8bce Better format documentation of \sphinx... LaTeX macros 2019-04-12 19:21:34 +02:00
jfbu
9ecd42574d Documentation of smartquotes_excludes (and smartquotes_action) 2019-04-12 18:34:10 +02:00
Takeshi KOMIYA
b0b3f5a677 deprecate PyClassmember class 2019-04-07 22:41:10 +09:00
Takeshi KOMIYA
df05d9254d Merge branch '2.0' 2019-04-07 19:29:52 +09:00
woutdenolf
6e0b0517c0 [autosummary] address code review 2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635
Merge branch 'master' into feature-autosummary-packages 2019-04-07 10:32:57 +02:00
Takeshi KOMIYA
9e2aba54d3 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-06 15:36:50 +09:00
Takeshi KOMIYA
c840cb744c Merge branch '2.0' into refactor_citations 2019-04-06 14:23:04 +09:00
Takeshi KOMIYA
452e5dcf21 Deprecate StandardDomain.process_*() 2019-04-06 14:14:18 +09:00
Takeshi KOMIYA
338941a49a Fix #6213: ifconfig: contents after headings are not shown 2019-04-05 02:34:23 +09:00
Takeshi KOMIYA
005913630f Add missing versionadded for autosummary_mock_imports 2019-04-04 23:49:43 +09:00
Takeshi KOMIYA
6cb263b9c8
Merge pull request #6212 from tsanikgr/feature/autosummary_imported_members
Allow setting imported_members for autosummary in conf.py
2019-04-04 23:04:36 +09:00
tsanikgr
eb03b1406f Simplify docs 2019-04-03 17:31:16 +01:00
Takeshi KOMIYA
885d35e374 Add CitationDomain for citation processing 2019-03-30 23:12:08 +09:00
Takeshi KOMIYA
87c6335b46 Move transforms for citations to sphinx.domains.citation 2019-03-30 20:31:10 +09:00
Takeshi KOMIYA
61098a0ae2 Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
Takeshi KOMIYA
a6ef53083c
Merge pull request #6215 from rkdarst/mathjax-doc-clarification
Clarify MathJax extension usage
2019-03-30 00:52:39 +09:00
Richard Darst
277588f2f9 Clarify MathJax extension usage: edits from review 2019-03-29 16:40:18 +02:00
Richard Darst
dd0246c6dc Clarify MathJax extension usage
- We recently hit an issue where we expected the MathJax extension to
  work with the default MathJax markup.  Obviously that shouldn't be
  the case (since then other formats couldn't use the math), but it
  can't hurt to include a hint.
- Link from the math HTML extension page to the relevant
  roles/directives.
- Also make it explicit that MathJax has a default, and that it's an
  external resource that will be dynamically linked.
2019-03-27 18:10:09 +02:00
tsanikgr
bec116a3b6 #5877: Allow setting imported_members for autosummary in conf.py 2019-03-27 14:19:16 +00:00
Takeshi KOMIYA
a990f9ff72 Add ObjectDescription.get_field_type_map()
Conceal caching mechanism of Field classes to ObjectDescription class.
This deprecates DocFieldTransformer.preprocess_field_types().
2019-03-23 17:27:22 +09:00
Michael Goerz
4e27cc465a Fix docs of inheritance-diagram "parts" option
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)

As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.

Closes #4872
2019-03-19 01:19:29 +09:00
Takeshi KOMIYA
e6cc18cc59
Merge pull request #6164 from goerz/inheritance_diagram
Fix docs of inheritance-diagram "parts" option
2019-03-19 01:18:07 +09:00
Jon Dufresne
22afc77c48 Python-3-only clean ups discovered by pyupgrade
https://github.com/asottile/pyupgrade

> A tool to automatically upgrade syntax for newer versions of the
> language.

- Drop u str prefix
- Drop base object inheritance
- Drop args to super()
- Use set literals
- Use dict comprehension
- Use set comprehension
2019-03-19 01:09:48 +09:00
Jon Dufresne
f210475489 Python-3-only clean ups discovered by pyupgrade
https://github.com/asottile/pyupgrade

> A tool to automatically upgrade syntax for newer versions of the
> language.

- Drop u str prefix
- Drop base object inheritance
- Drop args to super()
- Use set literals
- Use dict comprehension
- Use set comprehension
2019-03-17 12:58:03 -07:00
Takeshi KOMIYA
86d5d2113e Deprecate imports for compatibility 2019-03-17 18:30:50 +09:00
Takeshi KOMIYA
b5959ca230
Add SphinxPostTransform class (#6154)
* Add SphinxPostTransform

* Apply SphinxPostTransform to latex transforms
2019-03-17 18:27:00 +09:00
Michael Goerz
1f136215c1 Fix docs of inheritance-diagram "parts" option
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)

As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.

Closes #4872
2019-03-10 18:37:05 -04:00
Takeshi KOMIYA
2606002bb4
Merge pull request #6125 from tk0miya/doc-enhance_extension_dev_i18n
doc: Enhance documentation about internalization of external extension (refs: #5991)
2019-03-10 01:16:06 +09:00
Jakob Lykke Andersen
59b6a5e622
Merge pull request #6142 from anntzer/doctypo
Fix doc typo.
2019-03-09 11:51:24 +01:00
Takeshi KOMIYA
d4ac7217a8 Move list of deprecated API to extdev/deprecated.rst 2019-03-09 19:32:24 +09:00
Antony Lee
386ec9cd9a Fix doc typo. 2019-03-07 14:17:41 +01:00
Takeshi KOMIYA
ba86f4ea78 Merge branch '2.0' 2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
4ca5924d49
Merge pull request #6129 from tk0miya/refactor_util.nodes
Refactor util.nodes
2019-03-07 01:20:06 +09:00
Takeshi KOMIYA
b58d0e88ce
Merge pull request #6121 from tk0miya/refactor_NoUri
refactor: move NoUri to sphinx.errors
2019-03-03 16:09:35 +09:00
Takeshi KOMIYA
10869289ef docs: JS domain does not support reset current module 2019-03-03 14:56:38 +09:00
Takeshi KOMIYA
259c2bb8a6 refactor: Rename find_source_node() to get_node_source() 2019-03-03 14:42:23 +09:00
Takeshi KOMIYA
b3b5a595a9 docs: Update docs for i18n 2019-03-02 19:45:42 +09:00
Takeshi KOMIYA
4b15b6659f Move ext-i18n section to extdev/i18n.rst 2019-03-02 19:04:24 +09:00
Takeshi KOMIYA
ea1eec75dc Merge branch 'master' into doc-enhance_extension_dev_i18n 2019-03-02 19:00:25 +09:00
Takeshi KOMIYA
01f46111c5 Merge branch '2.0' 2019-03-02 18:38:24 +09:00
Takeshi KOMIYA
0d7bc86e7b refactor: move NoUri to sphinx.errors 2019-03-02 16:21:44 +09:00
Takeshi KOMIYA
8d0d75fea7
Merge pull request #6110 from tk0miya/refactor_catalog
Refactor catalog detection and compilation
2019-02-27 23:36:14 +09:00
Takeshi KOMIYA
fb8838ee53 refactor: Use CatalogRepository instead of find_catalog_source_file() 2019-02-27 22:47:08 +09:00
Takeshi KOMIYA
5f8f902b63 Rename find_catalog() to docname_to_domain() 2019-02-27 21:44:16 +09:00
Takeshi KOMIYA
af51e9825a refactor: Move implementation of mock to sphinx.ext.autodoc.mock 2019-02-27 21:42:23 +09:00
Takeshi KOMIYA
19b52c6eaa Replace :autolink: roles by class based implementation 2019-02-27 16:02:49 +09:00
Takeshi KOMIYA
ceef713e79 docs: Remove a term "new" from config values 2019-02-27 01:18:57 +09:00
Timotheus Kampik
4628264551
Merge pull request #6101 from TimKam/36-docs-google-search
#36 add Google Search how-to to FAQ
2019-02-26 15:07:34 +01:00
Timotheus Kampik
a814a2c191 #36 work in review feedback 2019-02-26 14:59:02 +01:00
Takeshi KOMIYA
51db9358fc
Merge pull request #6048 from stephenfin/doc-rework-tutorials
Doc rework (development guide, part 1)
2019-02-26 22:51:55 +09:00
Stephen Finucane
17596b5f3c docs: Remove unused imports
These were causing flake8 failures.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-25 11:03:59 +00:00
Timotheus Kampik
d5aa1c6ccc #36 add Google Search how-to to FAQ 2019-02-24 23:03:49 +01:00
woutdenolf
33e7b76c32
Merge branch 'master' into feature-autosummary-packages 2019-02-24 12:16:52 +01:00
woutdenolf
cb51216cac [autosummary] modify docs 2019-02-24 12:12:33 +01:00
Takeshi KOMIYA
9548b06d02 docs: Add a tip about $REQUESTS_CA_BUNDLE 2019-02-24 20:03:21 +09:00
Stephen Finucane
a35040c454 docs: Address further review comments
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-18 13:46:30 +00:00
Takeshi KOMIYA
1ca210aab1 Separate json and pickle to sphinxcontrib package 2019-02-17 22:31:50 +09:00
Takeshi KOMIYA
5437ab61e9
Merge pull request #6074 from tk0miya/1148_autodecorator
Closes #1148: autodoc: Add autodecorator directive for decorators
2019-02-16 21:45:36 +09:00
Takeshi KOMIYA
1ece29597e
Merge branch 'master' into simplify_conf.py 2019-02-16 21:25:21 +09:00
Takeshi KOMIYA
3ec032fa39 Replace :file: and :samp: roles by class based implementation 2019-02-16 12:37:46 +09:00
Takeshi KOMIYA
ea4d8ca08d Replace :guilabel: and :menuselection: roles by class based implementation 2019-02-16 02:30:28 +09:00
Takeshi KOMIYA
065ece6f4c docs: Add SphinxRole and ReferenceRole 2019-02-16 01:55:46 +09:00
Takeshi KOMIYA
9cb40436ed Replace :pep: and :rfc: roles by class based implementation 2019-02-16 00:34:24 +09:00
Takeshi KOMIYA
a6d345f95d Replace :index: role by class based implementation 2019-02-16 00:05:13 +09:00
Takeshi KOMIYA
686486498c Closes #1148: autodoc: Add autodecorator directive for decorators 2019-02-15 02:14:38 +09:00
Takeshi KOMIYA
3b49f9fe3d Separate htmlhelp to sphinxcontrib package 2019-02-15 01:44:32 +09:00
Stephen Finucane
5c061ff266 docs: Address review comments
helloworld:
- Return version metadata from extension
- Use 'reST' instead of 'rST'
- Don't use single backticks

todo:
- Return version metadata from extension
- Link to events section of API guide, rather than entire document
- Include name of phases in when describing build phases
- Use more method cross-references where possible
- Fix typo in usage example

recipe:
- Return version metadata from extension
- Rework code to simplify things
- Remove docstrings from 'generate' functions, which are simply
  duplicates of the original docstring
- Rename 'rcp' directive to 'recipe', the 'reref' role to 'ref', and a
  whole lot of variables to something more grokable
- Fix typos in both documentation and code

I've also fixed up the docstrings for some of the 'domain' functions to
make them render a little nicer (they took me a while to figure out).

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-14 10:31:45 +00:00
Takeshi KOMIYA
550c88f98c
Merge pull request #6064 from tk0miya/5636_add_autosummary_mock_imports
Closes #5635: autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-14 01:13:04 +09:00
Takeshi KOMIYA
1dfddb52ff
Merge pull request #6063 from tk0miya/4261_autosectionlabel_max_depth
Add autosectionlabel_max_depth config option
2019-02-14 01:12:05 +09:00
Takeshi KOMIYA
549a763195
Merge pull request #6025 from tk0miya/refactor_roles2
Introduce SphinxRole class as a base class of roles
2019-02-14 01:09:28 +09:00
Takeshi KOMIYA
73b8d6ff33 Closes #5636: autosummary: Add autosummary_mock_imports to mock external libraries 2019-02-11 23:19:25 +09:00
Takeshi KOMIYA
9f3feb6315 docs: autosectionlabel_maxdepth 2019-02-11 18:21:41 +09:00
Takeshi KOMIYA
12e65061f5 Update basic.css for HTML5 writer 2019-02-11 17:46:56 +09:00
Takeshi KOMIYA
a3cdd465ec HTML builder outputs HTML5 by default 2019-02-11 17:46:56 +09:00
Takeshi KOMIYA
a90a19aa0d
Merge pull request #6060 from tk0miya/drop_py2_2
refactor sphinx.util.pycompat
2019-02-11 17:39:42 +09:00
Takeshi KOMIYA
469e8afef7 docs: Use "Courier New" font to code blocks 2019-02-11 16:48:55 +09:00
Takeshi KOMIYA
2efc1065c0 Deprecate sphinx.util.pycompat:sys_encoding 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
b25deb259e refactor: Move NoneType to sphinx.util.typing 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
d40ce68c7b refactor: Move terminal_safe() to sphinx.util.console 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
e0ca116057 docs: Update location of builders 2019-02-11 13:46:32 +09:00
Takeshi KOMIYA
057ef31182 Fix typo 2019-02-11 13:25:24 +09:00
Takeshi KOMIYA
54be6ae494
Merge pull request #6053 from tk0miya/5459_autodoc_default_options_accepts_True
Closes #5459: autodoc: autodoc_default_options accepts True as a value
2019-02-11 12:48:43 +09:00
Takeshi KOMIYA
37ce1eb3b3 docs: githubpage now supports CNAME file 2019-02-11 12:46:35 +09:00
Takeshi KOMIYA
b0148c6921 Closes #5459: autodoc: autodoc_default_options accepts True as a value 2019-02-11 02:03:09 +09:00
Stephen Finucane
b1ebdcd3c6 doc: Add "recipe" tutorial
This is based on a post from opensource.com [1] and demonstrates how one
can use indexes for cross-referencing and domains to group these indexes
along with domains and roles. The source code was taken from [2] after
getting the license changed [3].

[1] https://opensource.com/article/18/11/building-custom-workflows-sphinx
[2] https://github.com/ofosos/sphinxrecipes
[3] https://github.com/ofosos/sphinxrecipes/issues/1

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Stephen Finucane
93081e2fce doc: Use 'literalinclude' directive for examples
This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Stephen Finucane
513d99c316 docs: Rework "todo" tutorial
Adopt the same format as was recently added in the "hello world"
tutorial, making this more of a walkthrough as expected from tutorials.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Stephen Finucane
7bce985ac9 docs: Rework the "helloworld" tutorial
Nothing to drastic going on here, but this format works better for other
tutorials we're adding.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Takeshi KOMIYA
319adefa9f epub: `epub_title defaults to the project` option 2019-02-09 15:00:27 +09:00
woutdenolf
555e675947 [autosummary] add modules and packages for modules 2019-02-08 16:10:43 +01:00
Takeshi KOMIYA
ac70a4dd91 Replace :abbr: role by class based implementation 2019-02-06 01:20:58 +09:00
Takeshi KOMIYA
ff80d2f538
Merge pull request #5983 from tk0miya/separate_applehelp
Separate applehelp to sphinxcontrib package
2019-02-06 01:14:02 +09:00
Takeshi KOMIYA
c4397318d3 Separate applehelp to sphinxcontrib package 2019-02-06 00:44:37 +09:00
Takeshi KOMIYA
20edbe9500
Merge pull request #6015 from tk0miya/1851_omit_argument_for_code-block
Close #1851: Allow to omit an argument for code-block directive
2019-02-06 00:24:17 +09:00
Takeshi KOMIYA
2e910d50f3
Merge pull request #6013 from tk0miya/update_manpage
doc: Remove --epub option from man page for sphinx-build
2019-02-04 01:53:21 +09:00
Takeshi KOMIYA
6ca669295c Close #1851: Allow to omit an argument for code-block directive 2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
e0e3ba4d91 doc: Fix indentation 2019-02-04 01:31:30 +09:00
Takeshi KOMIYA
e02526b056 doc: Remove --epub option from man page for sphinx-build 2019-02-04 00:29:53 +09:00
Vincent Férotin
98fd02e262 doc: Enhance documentation about internalization of external extension. 2019-01-28 15:48:50 +01:00
Takeshi KOMIYA
4b9e80bdb1
Merge pull request #5970 from tk0miya/separate_devhelp
Separate devhelp to sphinxcontrib package
2019-01-25 01:28:13 +09:00
Frank Erens
9e6fe21c6a Add 'cpp:struct' directive and 'cpp:struct' role.
They are cosmetic variants of the class directive/role.
2019-01-20 12:29:20 +01:00
Jakob Lykke Andersen
4e6dacd81b C++, add some missing .. versionadded directives. 2019-01-20 12:28:57 +01:00
Takeshi KOMIYA
2bd69350a7 Separate devhelp to sphinxcontrib package 2019-01-20 03:03:50 +09:00
Takeshi KOMIYA
6be9d2a08e Separate qthelp to sphinxcontrib package 2019-01-19 16:34:06 +09:00
jfbu
7e851510eb Fix duplicate reference (my wrong, refs: #5919) 2019-01-13 10:52:42 +01:00
Takeshi KOMIYA
20bf74c637 Separate jsmath to sphinxcontrib package 2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
6429c9e23c
Merge branch 'master' into refactor_singlehtml 2019-01-12 21:17:16 +09:00
Jakob Lykke Andersen
d6b7aad138 C++, alias directive
See sphinx-doc/sphinx#4981
2019-01-12 12:57:45 +01:00
Jean-François B
a8feb0bec8
Merge pull request #5919 from jfbu/latex_docs
[DOC] Move description of latex_elements to latex.rst
2019-01-12 11:05:50 +01:00
Takeshi KOMIYA
8b6acc05c4
Merge pull request #5909 from tk0miya/refactor_epub2
refactor: Convert Epub3Builder.validate_config_values() to a function
2019-01-12 18:22:00 +09:00
Takeshi KOMIYA
354e765eef refactor: Convert Epub3Builder.validate_config_values() to a function 2019-01-12 18:05:28 +09:00
Takeshi KOMIYA
51d6a096fb
Merge pull request #5910 from tk0miya/refactor_epub
Refactor epub builder: deprecate arguments of build_* method.
2019-01-12 17:47:08 +09:00
Takeshi KOMIYA
6e21598cea
Merge pull request #5926 from tk0miya/update_docs
Fix doc: html_baseurl was added in 1.8.0
2019-01-12 15:09:17 +09:00
Takeshi KOMIYA
b535e13235 Fix doc: html_baseurl was added in 1.8.0 2019-01-12 13:16:31 +09:00
Timotheus Kampik
4662a0ce4a
Fix ToC (#5917)
Intro should be first
2019-01-10 18:08:12 +01:00
Takeshi KOMIYA
b08a7c4757 Move SingleFileHTMLBuilder to sphinx.builders.singlehtml package 2019-01-11 01:59:56 +09:00
jfbu
ad8205bb0b [DOC] Move description of latex_elements to latex.rst 2019-01-10 16:48:03 +01:00
Timotheus Kampik
14b67a0464
Update Markdown doc (#5913)
* update Markdown doc

after relase of ecommonmark version 0.5.0
2019-01-09 16:44:00 +01:00
Takeshi KOMIYA
e82f5ddb55 The arguments of Epub3Builder.build_navigation_doc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
b6c422ac86 The arguments of EpubBuilder.build_epub() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
64533e142c The arguments of EpubBuilder.build_toc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
d437f39bc4 The arguments of EpubBuilder.build_content() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
f000df8bfb The arguments of EpubBuilder.build_container() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
0f972e8bbf The arguments of EpubBuilder.build_mimetype() is deprecated 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
7aa69237de
Merge pull request #5903 from tk0miya/show_deprecationwarnings_for_pycompat
refactor: deprecate some pycompat functions
2019-01-08 01:54:04 +09:00
Jon Dufresne
f1e41a616c Remove outdated fallback to 'import Image'
The fallback 'import Image' was added in commit
99621d7a01 for the PIL package. However,
the PIL package is no longer maintained and does not support Python 3.
Development has moved to the Pillow package which always installs to the
PIL namespace.

Pillow repo: https://github.com/python-pillow/Pillow
Old PIL website: http://www.pythonware.com/products/pil/
2019-01-07 06:44:35 -08:00
Takeshi KOMIYA
39c0380c4d refactor: deprecate some pycompat functions 2019-01-07 22:54:37 +09:00
Takeshi KOMIYA
353c3e9fd6
Merge pull request #5415 from tk0miya/5410_replace_open_file_by_open
refactor: Repalce HTMLHelpBuilder.open_file() by standard open()
2019-01-07 00:59:03 +09:00
Takeshi KOMIYA
56f4b27faa Deprecate LaTeXTranslator.generate_numfig_format() 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
45d04703fe latex: Move ExtBabel to sphinx.builders.latex.util package 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
3c7b4e77e0 refactor: Repalce HTMLHelpBuilder.open_file() by standard open() 2019-01-03 02:05:32 +09:00
Takeshi KOMIYA
76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
jfbu
58f4c658fa Capitalize the Internet 2018-12-29 18:54:06 +01:00
jfbu
b62bf0e0fc Redo spelling fix lost in merge (contents moved to other file)
modified:   doc/extdev/index.rst
2018-12-28 16:03:26 +01:00
jfbu
32d57b8637 Merge branch '1.8'
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
f811e4cea6
Merge pull request #5859 from tk0miya/fix_doc_for_viewcode_follow_imported_members
doc: Fix description for viewcode_follow_imported_members
2018-12-26 01:26:52 +09:00
Takeshi KOMIYA
b229c1a672
Merge pull request #5224 from TimKam/5216-update-markdown-doc
#5216 update Markdown config doc to API changes
2018-12-24 12:27:26 +09:00
Timotheus Kampik
3addad5f2a Merge branch 'master' into 5216-update-markdown-doc 2018-12-23 17:31:01 +01:00