Commit Graph

121 Commits

Author SHA1 Message Date
Georg Brandl
f73cbe8afa merge with 0.6 2010-01-03 19:44:21 +01:00
Georg Brandl
443eb4e594 Add "nature" theme, as used by PIP and distribute. 2010-01-03 19:40:07 +01:00
Georg Brandl
a5f1df6946 Mark code blocks as Python. 2010-01-03 19:38:17 +01:00
Georg Brandl
c8835d970b Added `alt option to graphviz` extension directives. 2010-01-03 12:02:31 +01:00
Georg Brandl
4d2a052c5f Note about linkcheck builder. 2010-01-03 10:24:49 +01:00
Georg Brandl
d32bd22ae7 #309: The `graphviz` extension can now output SVG instead of PNG
images, controlled by the ``graphviz_output_format`` config value.
Patch by Henrique Bastos.
2010-01-02 21:38:27 +01:00
Georg Brandl
ed78dc7ff0 merge with 0.6 2010-01-02 20:54:59 +01:00
Georg Brandl
6b13a28c11 Make extlinks more flexible: use string substitution to build the full URL. 2010-01-02 20:51:22 +01:00
Georg Brandl
f4da14806c #310: support exception messages in the `testoutput blocks of the doctest` extension.
Also add minimal test cases for the doctest extension.
2010-01-02 14:59:27 +01:00
Georg Brandl
32437e45bd merge with 0.6 2010-01-02 00:49:51 +01:00
Georg Brandl
0745637e69 Correct info about jsmath_path if given relative. 2010-01-01 23:54:45 +01:00
Georg Brandl
0238b8322d merge with 0.6 2009-12-24 13:32:16 +01:00
Georg Brandl
023b41b391 #296: fix copy-paste oversight. 2009-12-24 13:29:11 +01:00
Georg Brandl
4652c53a82 Add examples for graph options. 2009-11-08 10:18:35 +01:00
Georg Brandl
39a9330fc0 Fix autosummary_generate docs; a boolean value is supported only as of trunk. 2009-10-27 20:03:48 +01:00
Georg Brandl
2942a6f723 Fix whitespace. 2009-10-26 09:45:50 +01:00
Georg Brandl
66c254c582 copy over autosummary docs from trunk. 2009-09-09 19:18:02 +02:00
Georg Brandl
290a623669 Note that member docstrings need to be reST as well. 2009-09-09 19:10:24 +02:00
Georg Brandl
87cf9675c8 Fix markup. 2009-09-09 18:27:59 +02:00
Georg Brandl
c3b8e3fdf0 Clarify docs of automodule options. 2009-09-09 18:26:59 +02:00
Georg Brandl
5590675955 merge with 0.6 2009-11-09 00:33:49 +01:00
Georg Brandl
4f63b6cbd5 merge with 0.6 2009-10-26 09:46:04 +01:00
Georg Brandl
b51ed6d25d merge with 0.6 2009-09-09 19:18:48 +02:00
Pauli Virtanen
9043aeb723 autosummary: generate stub pages recursively 2009-06-19 16:57:43 +03:00
Georg Brandl
0ed845462f #169: Added the `trim_doctest_flags` config value, which is true by default. 2009-06-16 21:53:53 +02:00
Georg Brandl
a6fdc4602a merge with 0.6 2009-06-16 21:32:05 +02:00
Georg Brandl
269345a0f3 Clarify and fix typo. 2009-06-16 21:19:15 +02:00
Georg Brandl
812455e32c #200: Added `Sphinx.add_stylesheet()`. 2009-06-16 21:05:20 +02:00
Georg Brandl
7749debcdc Reformat autosummary docs. 2009-05-17 12:29:38 +02:00
Pauli Virtanen
472357e6a5 autosummary: allow user to override stub templates + improve the default templates 2009-05-15 00:22:30 +03:00
Pauli Virtanen
bbf4fe36c1 autosummary: accept 'autosummary_generate = True' in config files 2009-05-14 22:01:19 +03:00
Georg Brandl
40a044b6da Fix markup. 2009-05-03 10:24:28 +02:00
Georg Brandl
58da7a84fd Added the `extlinks` extension. 2009-05-02 20:38:45 +02:00
Georg Brandl
97ebfba6c8 Make doctest block definition clearer. 2009-04-27 17:34:27 +02:00
Georg Brandl
4d249fa3e4 Fix a few stylistic things, and add docs for autosummary_generate. 2009-04-13 08:40:56 +00:00
Pauli Virtanen
d9ae7c30cb autosummary: write documentation 2009-04-04 22:05:04 +03:00
Pauli Virtanen
73ae2f9c94 Some autosummary fixes 2009-03-21 00:34:46 +02:00
Sebastian Wiesner
73942678c8 #122: proxy support for intersphinx 2009-03-19 15:49:03 +01:00
Georg Brandl
338312dd61 Add autosummary doc stub. 2009-03-16 01:30:09 +01:00
Georg Brandl
e517911ac3 Autodoc can now exclude single members from documentation
via the ``exclude-members`` option.
2009-03-15 23:52:48 +01:00
Georg Brandl
a77888a42b Document setup_extension(). 2009-03-14 21:34:59 +01:00
Georg Brandl
d117ef45a3 Fix node class name. 2009-03-09 09:47:10 +01:00
Georg Brandl
fc30eea875 Update tutorial for directive classes. 2009-03-07 22:54:36 +01:00
Georg Brandl
9951bd3f73 Make titles consistent. 2009-03-05 00:17:14 +01:00
Georg Brandl
c5d0ba9913 New `inheritance_diagram` extension to embed... inheritance diagrams! 2009-03-05 00:14:29 +01:00
Georg Brandl
75637a5d6a New `graphviz` extension to embed graphviz graphs. 2009-03-04 23:52:56 +01:00
Georg Brandl
43dc531458 Fix grammar. 2009-03-04 23:49:32 +01:00
Georg Brandl
d2d3606158 Autodoc can now order members either alphabetically (like previously) or by member type;
configurable either with the config value ``autodoc_member_order`` or a ``member-order`` option per directive.

Also fix a bug that documented module-level functions as attributes.
2009-02-27 15:48:41 +01:00
Georg Brandl
dd32405563 Remove docs for removed automodule_skip_lines setting. 2009-02-27 15:22:45 +01:00
Georg Brandl
0c70b1caa0 Remove removed method. 2009-02-21 22:01:27 +01:00