Commit Graph

176 Commits

Author SHA1 Message Date
Takeshi KOMIYA
ba86f4ea78 Merge branch '2.0' 2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
10869289ef docs: JS domain does not support reset current module 2019-03-03 14:56:38 +09:00
Takeshi KOMIYA
01f46111c5 Merge branch '2.0' 2019-03-02 18:38:24 +09:00
Takeshi KOMIYA
ceef713e79 docs: Remove a term "new" from config values 2019-02-27 01:18:57 +09: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
Takeshi KOMIYA
9548b06d02 docs: Add a tip about $REQUESTS_CA_BUNDLE 2019-02-24 20:03:21 +09: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
686486498c Closes #1148: autodoc: Add autodecorator directive for decorators 2019-02-15 02:14:38 +09: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
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
a3cdd465ec HTML builder outputs HTML5 by default 2019-02-11 17:46:56 +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
Takeshi KOMIYA
319adefa9f epub: `epub_title defaults to the project` option 2019-02-09 15:00:27 +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
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
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
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
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
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
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
jfbu
58f4c658fa Capitalize the Internet 2018-12-29 18:54:06 +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
Timotheus Kampik
90181a16ed #5216 fix removal note 2018-12-23 17:28:44 +01:00
Timotheus Kampik
9583290653 #5216 add note regarding recommonmark version 2018-12-23 17:27:54 +01:00
Takeshi KOMIYA
5b2befe97d doc: Fix description for viewcode_follow_imported_members 2018-12-23 22:13:33 +09:00
Jon Dufresne
4e184754c9 Remove instructions to install Python 2 on Windows
As only Python 3 is supported, should not advise users to install Python
2.
2018-12-23 04:00:26 -08:00
jfbu
701b39328f Merge branch '1.8'
(Resolved) Conflicts:
	sphinx/texinputs/sphinxmanual.cls
2018-12-23 11:23:04 +01:00
Timotheus Kampik
20c9489828 #5216 change recommonmark installation instruction
the pypi package has not been updated since January 2016;
it is better to install from source
2018-12-23 10:43:39 +01:00