Yoshiki Shibukawa
0248416c65
Fix document for Kindle and add description about kindlegen
2016-09-01 12:46:12 +09:00
Ashley Whetter
cfd4e51802
Python domain can now link container types automatically
...
Google types now greedily match the closing parenthesis.
Also removed name from returns section in Google docstrings.
Instead, everything before the colon is treated as the type.
2016-08-03 17:09:40 +01:00
Yoshiki Shibukawa
d842a4cbc8
Turn off viewcode extension by default
2016-07-28 15:38:38 +09:00
Takeshi KOMIYA
80bfc55795
Merge branch 'stable'
2016-07-21 00:20:25 +09:00
Yoshiki Shibukawa
702004acfc
fix document download roles. download roles works only on html.
2016-07-19 23:15:35 +09:00
Takeshi KOMIYA
253eef9e6a
#2680 : sphinx.ext.todo now emits warnings if todo_emit_warnings enabled
2016-07-16 00:59:02 +09:00
Ville Skyttä
7cfbc2a702
Fix style checks
2016-07-07 16:48:12 +03:00
Rob Ruana
8eecdbd715
[Napoleon] Removes Python 2/3 compatible type annotation doc example, because they aren't current supported by Sphinx
2016-07-02 11:43:55 -04:00
Rob Ruana
2b60fc2027
Fixes #2688 : [Napoleon] Updates to Napoleon documentation to fix intersphinx links and demonstrate PEP 484 type annotations
2016-06-23 15:25:46 -04:00
Rob Ruana
ff34d02beb
Fix #2537 : [Napoleon] Corrects minor formatting issue on example NumPy Attributes section
2016-06-12 14:55:39 -06:00
Rob Ruana
32a852c1f1
Update #2374 : [Napoleon] clarifies documentation of napoleon_include_init_with_doc conf value
2016-06-11 18:28:48 -06:00
Takeshi KOMIYA
1d17475a08
#2575 : Now `sphinx.ext.graphviz allows :align:` option
2016-05-28 18:29:10 +09:00
Takeshi KOMIYA
c9296ba467
Merge branch 'stable'
2016-05-09 10:11:13 +09:00
nevimov
0960f0d9f2
Split doctest extension docs into sections
...
At the moment the docs have no sections at all. This commit adds
sections "Directives" and "Configuration" to facilitate navigation.
Also, it removes the outdated line about the number of directives
provided by the extension (there’s now 5 of them).
2016-05-02 02:02:55 +07:00
taschini
80bbdd4998
Reformatted doc for doctest_default_flags ( #2471 ).
2016-04-21 14:17:43 +02:00
taschini
604b45d44b
Incorporated feeback on doc for doctest_default_flags ( #2471 ).
2016-04-21 12:35:36 +02:00
taschini
8c1d9cc71c
Documenting doctest_default_flags config variable ( #2471 ).
2016-04-21 12:07:00 +02:00
Jan Duzinkiewicz
d8cd3ec4be
fix #2379 - Keyword args rendered with type links, as normal parameters (configurable under napoleon_use_keyword option)
2016-03-23 19:30:14 +01:00
Takeshi KOMIYA
d86ea47b52
Add `:caption:` option for sphinx.ext.inheritance_diagram
2016-03-11 13:20:05 +09:00
Georg Brandl
d59f23b2c8
Fix highlight languages in docs.
2016-02-14 09:37:55 +01:00
Takeshi KOMIYA
7a4f914f91
Fix #1286 , #2099 : Add `sphinx.ext.autosectionlabel` extension to allow reference sections using its title
2016-02-14 16:30:57 +09:00
Takeshi KOMIYA
dca1669b2f
Merge pull request #2300 from akruis/feature_autoclass_content_from__new__
...
Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
2016-02-14 14:45:25 +09:00
Georg Brandl
5e8642983b
Fixup links in the documentation.
2016-02-13 16:00:46 +01:00
shimizukawa
e2208c12a0
Update CHANGES and documentation for #1751 .
2016-02-08 23:31:02 +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
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
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
shimizukawa
e5860fd75c
Merge with '87998df9cbef2380345d436121e6bca43345d2bd' on stable
...
Conflicts:
tests/test_build_latex.py
2016-01-10 10:21:27 +09:00
Takeshi KOMIYA
0ea518d563
Add sphinx.ext.githubpages to publish the docs on GitHub Pages
2016-01-06 22:14:57 +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
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
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
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
Sgiath
abf8d86bb3
#2092 : Update documentation
2015-10-19 20:24:19 +02: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
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
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
shimizukawa
86edaeb8c4
remove or update missing links.
2015-03-07 22:07:46 +09:00
shimizukawa
332a912a47
fix http/https
2015-02-28 01:02:41 +09:00
shimizukawa
b0d40ea22c
Closes #1735 : Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation.
2015-02-23 04:20:35 +00:00
