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
8,214 Commits 2 Branches 219 Tags 163 MiB
a16b266ba8
Commit Graph

308 Commits

Author SHA1 Message Date
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
Georg Brandl
cc8a4a8126 Closes #817: note that math markup in docstrings needs to take care of backslashes. 2012-01-29 12:06:02 +01:00
Georg Brandl
c333f515cd Doc change for d7ac5e46307d 2012-05-08 12:51:28 +02:00
Georg Brandl
fe8ed35dfb Make it clearer how autodoc special comments have to be formatted. 2012-03-17 16:54:17 +01:00
Georg Brandl
53d06fda7b Closes #793: Fix docutils version references. 2011-11-01 09:16:37 +01:00
Georg Brandl
9a4a3c9afa Satisfy "make check". 2011-10-09 23:09:57 +02:00
Georg Brandl
e74a5541df Make it clear that math labels are internal. 2011-09-21 10:21:22 +02:00
Georg Brandl
ed0bad3889 Doc and changelog entries for 91b4fc984b32. 2011-07-23 10:04:09 +02:00
Georg Brandl
680d261694 s/jsmath/mathjax/ 2011-07-23 10:02:04 +02:00
bond
bfa6e8c0de some changes to math docs 2011-07-19 22:35:52 +02:00
Pauli Virtanen
e1be6ef8f8 autosummary: minor doc clarifications 2011-06-29 21:27:43 +02:00
Georg Brandl
99c505b63f Closes #683: set default MathJax path to the CDN URL, and update the docs accordingly. 2011-05-15 11:57:23 +02:00
Daniel Neuhäuser
e46a8e9ded Change redirected URLs to the new locations 2011-02-05 21:48:54 +01:00
Georg Brandl
a63230f12d #431: Doc comments for attributes can now be given on the same line as the assignment. 2011-01-15 15:40:59 +01:00
Georg Brandl
6e2324ab2c Add changelog entry and docs for #594. 2011-01-09 21:43:22 +01:00
Georg Brandl
87b0ac63ed merge with 1.0 2011-01-09 00:47:48 +01:00
Georg Brandl
b89e9b4346 Clarification. 2011-01-08 23:50:03 +01:00
Georg Brandl
bc6b586836 Added :confval:pngmath_add_tooltips. 2011-01-08 19:08:38 +01:00
Georg Brandl
210add8d2c Parse parmeter field in event descriptions. 2011-01-07 16:27:47 +01:00
Georg Brandl
7e5ff71c40 #513: Allow giving non-local URIs for JavaScript files, e.g. in the JSMath extension. 2010-08-25 10:26:15 +00:00
Georg Brandl
7518d19437 #469: document __all__ ordering in members. 2010-08-05 18:59:04 +02:00
Georg Brandl
580e1c90d3 #481, #482: fix `.name` reference matching. 
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with ``.name`` for modules too.
 2010-08-05 13:39:23 +02:00
Georg Brandl
01c501054e #480: Fix handling of target naming in intersphinx. 2010-08-05 11:58:43 +02:00
Georg Brandl
400617e692 #461: elaborate how to use intersphinx. 2010-07-10 16:59:23 +02:00
Georg Brandl
e48f7eb09a Fix interpolation error, encode inserted caption strings and add the caption in HTML output too. 2011-01-08 15:39:35 +01:00
Georg Brandl
30f85dab6e #367: Added automatic exclusion of hidden members in inheritance diagrams, and an option to selectively enable it. 2011-01-07 22:35:57 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
98d884da6e #306: Added :event:env-get-outdated event. 2011-01-07 16:41:44 +01:00
Georg Brandl
1675a454ce Added the :mod:sphinx.ext.mathjax extension, based on 
https://bitbucket.org/kevindunn/sphinx-extension-mathjax/ by Kevin Dunn.
 2011-01-06 13:21:36 +01:00
Georg Brandl
208e8a66e2 Add an option for the coverage builder if source-undocumented items are matched. 2011-01-04 22:50:13 +01:00
Georg Brandl
dd6984b7a9 merge with bb://mbrochh/sphinx 2011-01-04 22:22:23 +01:00
Georg Brandl
7beb8533b5 #273: Add an API for adding full-text search support for languages other than English. Add support for Japanese. 
Based on the implementation by SHIBUKAWA Yoshiki in https://bitbucket.org/shibu/sphinx/.
 2011-01-04 12:40:19 +01:00
Georg Brandl
a304c8d247 Fix-up half-sentence. 2011-01-03 23:50:30 +01:00
Georg Brandl
f6cb763ff8 #564: Add :confval:autodoc_docstring_signature which retrieves the signature from the first line of the docstring, if it is found there. 2011-01-03 22:51:33 +01:00
Georg Brandl
594c1a90f4 #520: Provide `special-members` option for autodoc directives. 2011-01-03 21:56:41 +01:00
Georg Brandl
92cb77a131 #176: Provide `private-members` option for autodoc directives. 2011-01-03 21:48:37 +01:00
Georg Brandl
7401622583 #553: Added :rst:dir:testcleanup blocks in the doctest extension. 2011-01-03 21:20:29 +01:00
Georg Brandl
92f6212c98 Add add_node() support for texinfo and add handlers for nodes in our extensions. 2010-10-22 11:16:23 +02:00
Chris Rebert
ef62d317e5 autodoc's docstring/special-comment detection works for instance attributes too 2010-10-02 00:05:59 -07:00
Doug Hellmann
4a00029a43 add 'inline' flag to graphviz extension directives to control paragraph breaks 2010-09-16 09:29:04 -04:00
Georg Brandl
3ddd7d9075 merge with 1.0 2010-08-25 12:02:59 +00:00
Georg Brandl
9c2747da91 #443: Allow referencing external graphviz files. 2010-08-23 13:07:28 +00:00
Georg Brandl
4d0facf1e1 Add the "oldcmarkup" extension, to help migrating to 1.0. 2010-05-24 15:12:27 +02:00
Georg Brandl
5b7e794e2b #413: Added a way for intersphinx to refer to named labels in other 
projects, and to specify the project you want to link to.
 2010-05-23 13:06:01 +02:00