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
