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
0745637e69
Correct info about jsmath_path if given relative.
2010-01-01 23:54:45 +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
269345a0f3
Clarify and fix typo.
2009-06-16 21:19:15 +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
Georg Brandl
1d128f57fa
Fix #106 , fix #107 : make _special_attrgetters an attribute of AutoDirective, to avoid confusion how it should be overridden in subclasses.
2009-02-19 22:54:34 +01:00
Georg Brandl
d4f5796f3b
The HTML builder now stores a small file named `.buildinfo` in
...
its output directory. It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing ``html_theme``).
2009-02-19 16:15:36 +01:00
Georg Brandl
219fdd282d
Add node structure picture.
2009-02-18 00:17:28 +01:00
Georg Brandl
8777c34779
Add link to docutils directive docs.
2009-02-18 00:13:12 +01:00
Georg Brandl
30fd6faddd
Document changes to the app API.
2009-02-17 19:33:46 +01:00
Georg Brandl
10c89799fd
Fix #93 : note that show-inheritance works with automodule.
2009-02-15 18:52:28 +01:00
Georg Brandl
1219e3e73a
merge with main
2009-02-14 23:25:30 +01:00
Georg Brandl
36b21d0570
Clarify what needs to be added to extensions.
2009-02-07 20:38:56 +01:00
Georg Brandl
d1e6119461
merge with trunk
2009-01-26 22:44:38 +01:00
Georg Brandl
bb291e5045
Add add_generic_role().
2009-01-22 20:01:01 +01:00
Georg Brandl
55c4f5a096
merge with trunk
2009-01-22 19:25:24 +01:00
Georg Brandl
29cc19a199
merge with 0.5
2009-01-22 19:23:23 +01:00
Georg Brandl
05cf79da52
A bit of clarification about where Sphinx finds autodoced modules.
2009-01-22 19:22:49 +01:00
Georg Brandl
aedbdd953d
Fix more line length and trailing whitespace.
2009-01-10 22:18:18 +01:00
Georg Brandl
34a08b862e
Document how autodoc with attributes works.
2009-01-06 00:28:29 +01:00
Georg Brandl
83c9f7a849
Improve builder docs a bit.
2008-12-26 20:17:59 +01:00
Georg Brandl
f4b1bb7b9e
Automated merge with file:///home/gbr/devel/sphinx0.5
2008-12-21 00:11:04 +01:00
Georg Brandl
1050c9bca5
Fix #58 : Add extension tutorial and better docs on where to put extensions.
2008-12-21 00:10:47 +01:00
Georg Brandl
a605255413
Automated merge with file:///home/gbr/devel/sphinx0.5
2008-12-15 19:31:12 +01:00
Georg Brandl
1dc46e6583
* #72 : In pngmath, make it possible to give a full path to LaTeX and
...
dvipng on Windows. For that to work, the ``pngmath_latex`` and
``pngmath_dvipng`` options are no longer split into command and
additional arguments; use ``pngmath_latex_args`` and
``pngmath_dvipng_args`` to give additional arguments.
2008-12-15 19:24:34 +01:00
Georg Brandl
5066f49fbe
Add "doctest_global_setup" conf val.
2008-12-15 12:33:13 +01:00
Georg Brandl
733b2b5bc6
Automated merge with file:///home/gbr/devel/sphinx0.5
2008-12-07 22:36:44 +01:00
Georg Brandl
8c055e8004
Document that mathbase isn't meant to be included in the extensions config
...
value.
2008-12-06 23:26:34 +01:00
Georg Brandl
50339493c6
Add Sphinx.add_lexer().
2008-11-30 19:58:29 +01:00
Georg Brandl
bd12a8e547
Some more fixes after the great renaming.
2008-11-29 20:04:11 +01:00
Georg Brandl
404625e718
Fix param name and add example.
2008-11-23 17:08:19 +01:00
