Georg Brandl
883324fd6c
Doc: move API docs in their own chapter and add more of it.
2014-01-20 17:21:44 +01: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
