Commit Graph

1345 Commits

Author SHA1 Message Date
shimizukawa
e2208c12a0 Update CHANGES and documentation for #1751. 2016-02-08 23:31:02 +09:00
SHIMIZU Taku
bca16504d1 Add a documentation for epub3 builder. 2016-02-07 14:20:32 +09:00
Anselm Kruis
0311f33347 Feature: enhance autoclass:: to use the docstring of __new__
The method new is an alternative to __init__, but autoclass does not 
respect __new__. This commit enhances the directive autoclass:: to try
__new__ method's docstring, if __init__ method's docstring is missing or
empty.

The commit also adds tests and updates the documentation.
2016-02-05 19:09:43 +01:00
shimizukawa
c6289c311f Fix documentation for 'mo auto build". 2016-01-30 16:37:58 +09:00
shimizukawa
8740030e80 Fix documentation for 'mo auto build". 2016-01-30 16:14:48 +09:00
Takeshi KOMIYA
ae478f678e Fix #2022: html_extra_path also copies dotfiles and refers exclude_patterns 2016-01-24 19:17:50 +09:00
Takeshi KOMIYA
04a8c26eab Fix #2235: `needs_sphinx` supports micro version comparison 2016-01-21 13:51:17 +09:00
Takeshi KOMIYA
40a1b37d99 Merge pull request #1939 from bukzor/dummy-builder
add a dummy builder, for syntax checkers
2016-01-20 10:36:00 +09:00
Hong Xu
540400635a math: Add math_number_all to enforce numbering all displayed math. 2016-01-18 23:47:01 -08:00
Takeshi KOMIYA
0cbb29e342 Update docs for #2221 2016-01-19 00:53:10 +09:00
Takeshi KOMIYA
4c4450d958 Fix #656: Add `graphviz_dot option to graphviz directives to switch the dot` command 2016-01-18 23:56:05 +09:00
Takeshi KOMIYA
cf5e138a53 Merge pull request #2207 from tk0miya/baseclass_for_parsers
Add sphinx.parsers.Parser class; a base class for new parsers
2016-01-17 19:17:58 +09:00
Takeshi KOMIYA
f89e3dfee3 Update docs about sphinx.parsers.Parser class 2016-01-17 19:18:02 +09:00
Takeshi KOMIYA
738bb589d9 Merge pull request #2209 from tk0miya/2162_add_source_parser_API
Fix #2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension
2016-01-17 19:07:18 +09:00
Takeshi KOMIYA
8c8f3dbc9b Merge pull request #2208 from tk0miya/2027_html_title_only_accepts_string
Fix #2027: ``make epub`` got errors if ``html_title`` is None
2016-01-17 18:59:44 +09:00
Georg Brandl
4f72bdb722 Merge branch 'stable' 2016-01-14 22:54:08 +01:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
shimizukawa
f824539119 merge with stable 2016-01-13 00:13:35 +09:00
Takeshi KOMIYA
8ea92359ba Fix warnings in CHANGES and docs 2016-01-12 13:36:12 +09:00
Takeshi KOMIYA
3ebee4d22d Merge pull request #1934 from jpic/styleguide_link
Link to Python's Style Guide for documentation.
2016-01-11 01:38:45 +09:00
Takeshi KOMIYA
e4b9eb51f6 Merge branch 'stable' 2016-01-11 00:27:26 +09:00
shimizukawa
09b931745d Switch links for pdf version documentation to on ReadTheDocs. 2016-01-10 11:18:55 +09:00
shimizukawa
ff01b78412 Remove version specific installation procedure and link to stable/latest document page because sphinx site has been moved to ReadTheDocs so the information is obsoleted. 2016-01-10 11:18:44 +09:00
shimizukawa
e5860fd75c Merge with '87998df9cbef2380345d436121e6bca43345d2bd' on stable
Conflicts:
	tests/test_build_latex.py
2016-01-10 10:21:27 +09:00
Takeshi KOMIYA
7894f0bd9c Fix #2225: If the option does not begin with dash, linking is not performed 2016-01-09 19:57:23 +09:00
Takeshi KOMIYA
bef3025c3c Fix #1900: BuildEnvironment.srcdir documentation gives false information 2016-01-07 14:18:40 +09:00
Takeshi KOMIYA
695e4fdef9 Merge pull request #2214 from tk0miya/2203_sphinx.ext.githubpages
Add sphinx.ext.githubpages to publish the docs on GitHub Pages
2016-01-06 22:37:33 +09:00
Takeshi KOMIYA
0ea518d563 Add sphinx.ext.githubpages to publish the docs on GitHub Pages 2016-01-06 22:14:57 +09:00
Georg Brandl
3bd7d08b6f Merge pull request #2170 from daoiqi/zh-search
add Chinese Search into milestones
2016-01-06 10:34:36 +01:00
Takeshi KOMIYA
f81ab1e8b9 Fix #2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension 2016-01-04 10:23:17 +09:00
Takeshi KOMIYA
00b909f9b6 Fix warnings caused by renaming pngmath in CHANGES and docs 2016-01-02 17:58:41 +09:00
Takeshi KOMIYA
01a526793d Fix typos #2122 (cherry-picked by hand) 2016-01-02 11:17:59 +09:00
Jakub Wilk
f86217c9d1 Fix typos. 2016-01-01 20:54:30 +01:00
Takeshi KOMIYA
3c907f2337 Fix #2027: `make epub got errors if html_title` is None
Sphinx does not expect setting None value as ``html_title`` in
spite of documented.
This changed that to deny None value as ``html_title``.
2016-01-01 10:35:45 +09:00
Hong Xu
f233c604ef imgmath: Make the size of the displayed math customizable. 2015-12-29 15:14:04 -08:00
Hong Xu
f68bfbdbb7 Update the pngmath doc to synchronize with imgmath 2015-12-29 15:14:04 -08:00
Takeshi KOMIYA
87998df9cb Fix a documentation for sphinx.ext.viewcode 2015-12-27 01:32:40 +09:00
shimizukawa
bf1cc70996 Merge with 'stable' 2015-12-20 08:48:38 +09:00
Georg Brandl
8232707a12 merge stable to default 2015-12-18 21:42:55 +01:00
Hong Xu
691141d23f sphinx.ext.graphviz: Add doc to explain how to make the links in svg output work. 2015-12-16 19:33:17 -08:00
daoiqi
d76a700fa2 add chinese search options into html_search_options document 2015-12-13 17:07:11 +08:00
Buck Evan
59c64a36c5 Merge branch 'master' into dummy-builder 2015-12-09 17:07:08 -08:00
shimizukawa
32d4ab51bd Update CHANGES refs #1757 2015-12-09 17:00:40 +09:00
Takayuki SHIMIZUKAWA
8bfc9409ec Merge pull request #1757 from hemmecke/master
fix unclear documentation for html_last_updated_fmt
2015-12-09 16:54:45 +09:00
Takeshi KOMIYA
aa475604dc `figure_align` is added at 1.3 2015-12-03 23:31:54 +09:00
shimizukawa
9ceea10a62 Merge with 'stable' 2015-11-29 23:10:21 +09:00
shimizukawa
47bdbd1655 Fix #1818: sphinx.ext.todo directive generates broken html class attribute as 'admonition-' when :confval:language is specified with non-ASCII linguistic area like 'ru' or 'ja'. To fix this, now `todo directive can use `:class:` option. 2015-11-29 12:02:02 +09:00
Jakob Lykke Andersen
89d7ab6941 C++, tparam info field docs. 2015-11-21 16:51:17 +01:00
Rob Ruana
e926ebb263 Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default 2015-11-17 20:13:55 -08:00
shimizukawa
8ae43b9fd4 Merge branch 'stable' 2015-11-15 18:07:23 +09:00