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
Takayuki SHIMIZUKAWA
c4850cc9ab
Merge pull request #2004 from cjmayo/theming
...
Stop theme description stretching around screenshots in html output
2015-11-15 16:51:45 +09:00
Rob Ruana
132791c852
Merge pull request #2093 from Sgiath/napoleon-todo
...
#2092 : Napoleon 'todo' directive
2015-11-12 14:02:48 -08:00
shimizukawa
9ff6eb55f8
fix typo
2015-10-27 22:52:44 +09:00
Sgiath
abf8d86bb3
#2092 : Update documentation
2015-10-19 20:24:19 +02:00
Jakob Lykke Andersen
5f09ecd4cf
C++, cross-reference update
...
(see also sphinx-doc/sphinx#2057 )
- Elaborate the documentation in regard to templates.
- Add shorthand for template declarations.
- Add shorthand for (full) template specialisations.
- Add better error messages for unparseable references.
2015-10-14 09:41:52 +09:00
shimizukawa
cdf74eb8d1
builders page indicates 'format' value for each builders. refs #2038
2015-09-15 10:25:50 +09:00
TAKASE Arihiro
5e1028db43
Fix the language code for Portuguese
2015-09-13 10:07:34 +09:00
TAKASE Arihiro
8e7166df1e
Fix the language code for Portuguese
2015-09-11 19:46:27 +09:00
Jakob Lykke Andersen
a22fb0d45f
C++, add namespace push/pop directives.
2015-09-06 22:28:55 +02:00
Jakob Lykke Andersen
89c3dd81c3
C++, support for templates.
...
Fixes sphinx-doc/sphinx#1729 .
2015-09-06 15:36:58 +02:00
Chris Mayo
888cdc0b14
Stop theme description stretching around screenshots in html output
2015-08-16 19:37:02 +01:00
shimizukawa
d51228152e
merge with stable
2015-07-25 18:15:09 +02:00
Georg Brandl
bf7d0ccd75
Fixes #1887 : note that graph name needs quotes if non alphanumeric.
2015-07-25 17:04:06 +02:00
shimizukawa
468568bdcf
fix obsoleted documentation
2015-07-25 15:55:43 +02:00
Edoardo Batini
4b64814f8f
Document `cmdoption` directive deprecation
2015-07-25 12:45:18 +02:00
kyleknap
cfb3a75953
Update `'releasename'` latex element docs
...
To address https://github.com/sphinx-doc/sphinx/issues/1782
2015-07-25 03:00:47 -07:00
Masafumi Yokoyama
2522afe94d
doc: adjust underline length of section headers
2015-07-22 00:51:10 +09:00
Hans Moritz Günther
6a40cbf0e0
Correct minor typo in confic.py
2015-07-12 10:08:36 -04:00
Takayuki SHIMIZUKAWA
445db4f958
Merge pull request #1830 from thomasvandoren/ref-chapel-domain-in-docs
...
Add reference to Chapel domain in domains document.
2015-07-11 15:25:12 +09:00
Robert Lehmann
f323b60641
Explicitly mention sphinx-users mailing list
...
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.
I have checked this in a Web browser and it looks good IMO (box not overfull.)
2015-06-24 21:13:24 +09:00
Robert Lehmann
e8ab6cc44e
Explicitly mention sphinx-users mailing list
...
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.
I have checked this in a Web browser and it looks good IMO (box not overfull.)
2015-06-24 13:32:01 +02:00
Buck Golemon
59dfb47c1c
add a dummy builder, for syntax checkers
2015-06-23 16:23:27 -07:00
jpic
9265010609
Link to Python's Style Guide for documentation.
...
This is a follow-up to #1931
2015-06-19 18:14:02 +02:00
Rob Ruana
27be6614f7
[Napoleon] Miscellaneous formatting fixes to napoleon example docstrings
2015-06-14 13:32:04 -07:00
Rob Ruana
d5d6556a8a
[Napoleon] Updates docs to use single quoted strings & 4-space indentation
2015-06-11 20:21:37 -07:00
Georg Brandl
bfdbee0d04
merge with stable
2015-06-11 19:07:10 +02:00
Rob Ruana
34add11b5d
Closed #1925 : [Napoleon] provides @property examples & recommends PEP 484 type hints in Napoleon docs
2015-06-09 18:18:22 -07:00
Takayuki SHIMIZUKAWA
20cba249ef
Merge pull request #1910 from bgeron/patch-1
...
Fix a typo in doc/markup/toctree.rst.
2015-06-08 06:47:49 +08:00
shimizukawa
a9afcb8831
Fix #1920 Minor documentation bug in windows install guide.
2015-06-07 17:08:06 +08:00
Takayuki SHIMIZUKAWA
381d9ef7c5
Merge pull request #1876 from ericholscher/source_suffix_in_build
...
Add suffix to doc context. Fixes #1873 .
2015-06-07 08:59:13 +08:00
Eric Holscher
5f6503c905
Add suffix to HTML context. Fixes #1873
2015-06-06 13:12:56 -07:00
Bram Geron
f1f4342e9a
Fix a typo in doc/markup/toctree.rst.
2015-05-29 12:51:01 +01:00
Georg Brandl
55368daa91
merge with stable
2015-05-18 14:26:44 +02:00
Jean Jordaan
56c51ff4b0
Some language edits while reading
2015-05-15 13:18:19 +08:00
Tomoko Uchida
1d22c20664
Add requirement notation for type 'janome'.
2015-04-18 18:22:42 +09:00
Tomoko Uchida
e3bc5bb077
Allow to choose Janome for Japanese splitter.
2015-04-18 17:05:14 +09:00
shimizukawa
2ee54dfd0b
add make.bat for sphinx/doc
2015-04-06 14:18:28 +09:00
Thomas Van Doren
297f5f143d
Add reference to Chapel domain in domains document.
2015-04-03 16:55:56 -07:00
Lukas Prokop
82345f5c11
speicifer -> specifier
2015-03-22 11:28:25 +01:00
shimizukawa
8fb6516256
fix typo.
2015-03-17 07:32:31 +09:00
shimizukawa
25251a3d53
Closes #1651 : Documentation: add `vartype` field description for python domain.
2015-03-09 22:51:20 +09:00
Georg Brandl
548a6dc22e
final pep8 fixes; reactivate most warnings in flake8
2015-03-08 17:15:54 +01:00
Georg Brandl
3437872b30
merge
2015-03-08 15:38:28 +01:00
Georg Brandl
705f6a997b
Merge branch 'apple-help' of git://github.com/al45tair/sphinx
2015-03-08 15:35:04 +01:00
shimizukawa
e2a921ff07
refs #1742 : :name: option is provided for toctree, code-block and literalinclude dirctives.
2015-03-08 21:59:37 +09:00
Georg Brandl
ad612fb03d
Change the source parsers feature a bit:
...
* parsers -> source_parsers
* add docs
* require fully qualified name or class
* add test for it
2015-03-08 13:12:50 +01:00
shimizukawa
26ae055b2d
refs #1700 : now toctree caption become paragraph block instead of Text under ul element. and add permalink for toctree caption.
2015-03-08 16:45:56 +09:00
Takeshi KOMIYA
5e48ac9b4f
Role `numref uses %s as special character instead #` symbol
2015-03-08 08:30:16 +09:00
shimizukawa
86edaeb8c4
remove or update missing links.
2015-03-07 22:07:46 +09:00
Ralf Hemmecke
2c58eef1d1
fix unclear documentation for html_last_updated_fmt
2015-03-07 09:06:58 +01:00
shimizukawa
04e3e761d7
tweak documentation: default is mercurial term. use master for git term instead.
2015-03-04 00:52:47 +09:00
shimizukawa
cdc4f5d8bb
fix http/https
2015-02-28 01:10:03 +09:00
