Takeshi KOMIYA
75203967d8
Merge branch '3.x'
2020-05-04 00:15:20 +09:00
Takeshi KOMIYA
1ba671a677
Deprecate ignore parameter for Documenter.get_doc()
2020-05-03 01:59:47 +09:00
Takeshi KOMIYA
f82151bda5
Merge branch '3.x'
2020-05-02 10:43:10 +09:00
Takeshi KOMIYA
71eddf3095
Merge branch '3.x'
2020-04-30 21:49:28 +09:00
Takeshi KOMIYA
155cb87452
doc: Fix examples of doctest extensions are still in py2 (refs: #7575 )
2020-04-29 22:46:44 +09:00
Takeshi KOMIYA
a86346aca6
Remove deprecated features marked as RemovedInSphinx40Warning
2020-04-29 15:12:39 +09:00
Takeshi KOMIYA
aa773cbc88
Merge branch '3.x'
2020-04-28 01:42:37 +09:00
Takeshi KOMIYA
87308d9607
Close #7143 : py domain: Add :final: option to py:*: directives
2020-04-28 01:24:29 +09:00
Takeshi KOMIYA
4eafda8588
Merge pull request #7546 from tk0miya/4030_autosummary_context
...
Close #4030 : autosummary: Add autosummary_context
2020-04-27 02:01:34 +09:00
Takeshi KOMIYA
42aa293679
Merge branch '3.x'
2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
e5192ba48b
refactor: AutosummaryRender
2020-04-25 01:25:00 +09:00
Takeshi KOMIYA
0374d217d4
refactor: Deprecate unused parameters
2020-04-23 22:54:53 +09:00
Takeshi KOMIYA
931bfcca88
refactor: autosummary: Change first argument for AutosummaryRenderer
2020-04-23 22:51:23 +09:00
Takeshi KOMIYA
ebfa8dbf2a
Merge pull request #7538 from tk0miya/7535_autogen_crashes_on_inherited_template
...
Fix #7535 : sphinx-autogen: crashes when custom template uses inheritance
2020-04-23 21:46:06 +09:00
Takeshi KOMIYA
61b823ad10
refactor: Deprecate unused parameters
2020-04-23 02:25:58 +09:00
Takeshi KOMIYA
c9e4945623
Merge pull request #7473 from eric-wieser/meta-public
...
Add support for :meta public:
2020-04-23 02:15:42 +09:00
Takeshi KOMIYA
e1c7e9d481
Fix #7534 : docs: Big vertical whitespace rendered in official doc
2020-04-22 23:37:44 +09:00
Takeshi KOMIYA
6e28675727
doc: Fix version
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
7671bcc23b
Remove autosummary_recursive configuration
...
Now autosummary directive has :recursive: option to enable the
recursive feature individually. So the configuration is no longer
needed.
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc
Merge branch '3.x' into 6040_autosummary_recursive
2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca
autosummary: Add :recursive: option to autosummary directive
2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
c2c95ef587
Merge pull request #7411 from tk0miya/latex_theme_options
...
LaTeX: Add `latex_theme_options` to override theme options
2020-04-20 01:50:06 +09:00
Takeshi KOMIYA
12cb90c3fa
Merge pull request #7492 from tk0miya/7490_autosummary_caption
...
Close #7490 : autosummary: Add ``:caption:`` option to autosummary directive
2020-04-20 00:52:45 +09:00
Takeshi KOMIYA
05aff200b1
LaTeX: Add :confval:latex_theme_options
to override theme options
2020-04-20 00:51:08 +09:00
Takeshi KOMIYA
b5066cf48f
Merge pull request #7513 from tk0miya/7488_docs
...
Fix #7488 : Update docs
2020-04-20 00:47:34 +09:00
Takeshi KOMIYA
2c7d64b94c
Merge branch '3.x'
2020-04-19 23:45:57 +09:00
Takeshi KOMIYA
68375c92f2
Fix #7488 : Update docs
2020-04-19 23:01:57 +09:00
Takeshi KOMIYA
4627742cb3
doc: Fix html_use_opensearch of sphinx-doc.org
2020-04-19 01:50:38 +09:00
Takeshi KOMIYA
adad0e62bb
Merge branch '3.x'
2020-04-18 21:54:31 +09:00
Matthias Geier
fc78f09441
DOC: Use html_baseurl
2020-04-17 17:01:48 +02:00
Takeshi KOMIYA
1e3ce31b03
Merge pull request #7443 from mgeier/theme-options-toctree
...
Add globaltoc_collapse and globaltoc_includehidden options
2020-04-16 23:11:28 +09:00
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