IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
9,837 Commits 2 Branches 219 Tags 163 MiB
a331e90c87
Commit Graph

351 Commits

Author SHA1 Message Date
Rob Ruana
f45fe6fc8c Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if Napoleon doesn't care if the member is skipped 2016-11-23 10:45:39 -08:00
Takeshi KOMIYA
22545a0927 #3136: Add `:name: option to the directives in sphinx.ext.graphviz` 2016-11-12 23:05:59 +09:00
Takeshi KOMIYA
4063a67d19 Fix #2474: Add `intersphinx_timeout option to sphinx.ext.intersphinx` 2016-09-01 23:00:31 +09:00
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
Georg Brandl
91887b0183 Merge branch 'stable' 2015-01-02 13:51:31 +01:00
Georg Brandl
a84e036622 development process updates: bb->gh, hg->git 2015-01-02 13:49:38 +01:00
Takayuki Shimizukawa
dc482fd247 use reference to python 3.4 for intersphinx 2014-10-30 10:08:33 +09:00
Takayuki Shimizukawa
0633892fde Update CHANGES for pull request #275, #1537; sphinx.ext.intersphinx supports multiple target for the inventory. 2014-08-23 12:07:59 +09:00
Takayuki Shimizukawa
aa744dda97 Merged in bsipocz/sphinx (pull request #275) 
Adding the option of multiple inv for the same name & uri
 2014-08-23 11:50:18 +09:00
Takayuki Shimizukawa
e8b870de0c :mod:~sphinx.ext.viewcode support imported function/class aliases. Closes #623 2014-08-22 11:38:56 +09:00
Brigitta Sipocz
64b915bdbe fix typo 2014-08-21 12:50:21 +01:00
Brigitta Sipocz
452f59af0e Addressing comment and adding docs 2014-08-21 12:47:32 +01:00
EricFromCanada
178a97cd73 improved consistency for how docs refer to True and False 2014-06-18 12:34:28 -04:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
EricFromCanada
8981b9bd13 corrections for misspellings 2014-06-18 11:19:01 -04:00
Rob Ruana
71b8fe8854 Closes #1489: Removes use of ":annotation:" for attribute types in napoleon, as inline markup is not allowed 2014-06-13 14:06:39 -06:00
Takayuki Shimizukawa
638458038d tiny documentation fix 2014-04-28 19:41:14 +09:00
Rob Ruana
7f710be021 Updates Napoleon documentation per suggestion by a user 2014-04-26 19:43:46 -04:00
Rob Ruana
18df6421bf Closes #1396: Param types with inline markup no longer italicized 
Napoleon was attempting to render nested inline markup
( [a big no-no!](http://sphinx-doc.org/rest.html) ) for
parameter types. Now, if Napoleon sees any backquotes
in the parameter type, it is rendered without italics.
 2014-03-09 01:56:56 -05:00
Georg Brandl
02363c3ce2 merge with stable 2014-03-06 08:13:14 +01:00
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +01:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
4c782604ed Merged birkenfeld/sphinx into default 2014-01-19 12:31:07 -05:00
Georg Brandl
5023da8ac3 mock: little changes, changelog and versionadded 2014-01-19 10:34:52 +01:00
Georg Brandl
91cd11be3c Merged in guibog/sphinx2 (pull request #184) 
autodoc extension: add autodoc_mock_imports config value
 2014-01-19 10:31:15 +01:00
Rob Ruana
d11cb7325e Merge conflicts 2014-01-18 14:23:23 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Georg Brandl
24a8b516bf Remove sphinx.ext.oldcmarkup compatibility extension. 2014-01-17 07:24:23 +01:00
Georg Brandl
06364ca784 Closes #1174: Fix smart quotes being applied inside roles like :rst:role:program or :rst:role:makevar. 2014-01-12 17:01:22 +01:00
guibog
a8f65e9d3c autodoc extension: add autodoc_mock_imports config value 2013-10-23 16:36:45 +08:00
Georg Brandl
c5ff9386d6 Fix autodoc. 2013-10-12 21:01:25 +02:00
Georg Brandl
695cebd254 Add sphinx.version_info for better programmatic check of the Sphinx version. 2013-10-12 20:48:03 +02:00
Georg Brandl
ea8fad0de6 Removed the `sphinx.ext.refcounting` extension -- it is very specific to 
CPython and has no place in the main distribution.
 2013-10-12 19:27:49 +02:00
Georg Brandl
44418fd1a1 changelog update for PR#136 2013-09-16 09:26:14 +02:00
Georg Brandl
d2b4f9a095 Merged in Vladimirsson/sphinx (pull request #136) 
Added ``imported-members`` option for ``automodule`` directive in autodoc
 2013-09-16 09:23:56 +02:00
Georg Brandl
e732807869 Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109) 
feature: autodoc: add :annotation: option for autodata and autoattribute
 2013-09-16 04:25:53 +02:00
Eric Holscher
f62a28d805 Add link to referenced docutils docs. 2013-07-11 13:30:17 -07:00
Bogdan Opanchuk
a7a4f7569a Added `imported-members option for automodule` directive in autodoc 2013-04-20 21:58:18 +10:00
Georg Brandl
08839fac68 docs: fix link to MathJax documentation 2013-03-30 14:08:33 +01:00
Takayuki Shimizukawa
e30b1325ef Because it was thought MaxJax CDN URL has not been written intentionally, I undo the changes. 
See also #683.
Backed out changeset 2f9a30b7d005.
 2013-03-29 10:52:52 +09:00
Takayuki Shimizukawa
c4a999f682 add missing mathjax_path default value in document. 2013-03-29 10:45:24 +09:00
Johannes Dewender
649ab8030c autodoc: change :novalue: to :annoation: option 
The :novalue: option is now called :annotation: and has an additional feature:
When given with an argument, you can specify what the annotation
of the object will be.
 2013-02-27 16:38:55 +01:00
Johannes Dewender
391f99d13a autodoc: document novalue option 
The update is listed for version 1.2.
This should be changed if the change is released later.
 2013-01-22 17:58:47 +01:00
Jonathan Waltman
55b28b0198 Fix whitespace / line length issues reported by "make test" 2012-11-03 11:04:32 -05:00
Georg Brandl
0c02841412 Closes #1010: Make pngmath images transparent by default; IE7+ should handle it. 2012-10-28 19:06:48 +01:00
Georg Brandl
10a65f62ef Linkcode changelog entry. 2012-10-28 18:22:53 +01:00
Georg Brandl
201883d209 Merged in pv/sphinx-work/ext-linkcode (pull request #47) 2012-10-28 18:21:57 +01:00
Pauli Virtanen
da4ba903a3 DOC: linkcode: fix up documentation a bit 2012-03-11 17:55:29 +01:00
Pauli Virtanen
135bb6f6c8 ENH: add a linkcode extension 2012-03-11 17:48:51 +01:00