Commit Graph

108 Commits

Author SHA1 Message Date
Georg Brandl
5590675955 merge with 0.6 2009-11-09 00:33:49 +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
4f63b6cbd5 merge with 0.6 2009-10-26 09:46:04 +01:00
Georg Brandl
2942a6f723 Fix whitespace. 2009-10-26 09:45:50 +01:00
Georg Brandl
b51ed6d25d merge with 0.6 2009-09-09 19:18:48 +02: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
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
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