Commit Graph

288 Commits

Author SHA1 Message Date
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
717be1cd0e Add headlink/headbgcolors. 2009-02-27 12:11:35 +01:00
Georg Brandl
fb511a015a Paths to literal include files and download files can now be absolute too. 2009-02-24 13:38:15 +01:00
Georg Brandl
2f13231fbd merge with 0.5 2009-02-23 19:24:02 +01:00
Georg Brandl
cadb5af9f1 Note that Python code in code blocks is parsed. 2009-02-23 19:23:08 +01:00
Georg Brandl
7792e27030 #10: implement HTML section numbering. 2009-02-22 15:22:23 +01:00
Georg Brandl
69aab57297 Small cosmetic fix. 2009-02-22 14:46:47 +01:00
Georg Brandl
0c70b1caa0 Remove removed method. 2009-02-21 22:01:27 +01:00
Georg Brandl
7073a5bd2c The new `latex_additional_files` config value can be used to
copy files (that Sphinx doesn't copy automatically, e.g. if they
are referenced in custom LaTeX added in ``latex_elements``) to
the build directory.
2009-02-20 11:20:15 +01:00
Georg Brandl
d3a7f004f0 Oops. 2009-02-20 11:09:54 +01:00
Georg Brandl
a07e7ad534 #62: There is now a `-w` option for sphinx-build that writes
warnings to a file, in addition to stderr.
2009-02-20 11:01:46 +01:00
Georg Brandl
a43b651804 Make "make check" happy. 2009-02-19 23:31:34 +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
4c81b055c8 Added an `only` directive that can selectively include text
based on enabled "tags".  Tags can be given on the command
line.  Also, the current builder output format (e.g. "html" or
"latex") is always a defined tag.
2009-02-19 21:56: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
2dff2e3bfa Add DirectoryHTMLBuilder (contributed as PrettyHTMLBuilder by Will Maier). 2009-02-19 00:07:47 +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
f07d0afef2 Note how to change default role. 2008-12-28 21:29:40 +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
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
c49d8217e9 Fix #70: clarify meaning of |today|. 2008-12-15 10:26:07 +01:00
Georg Brandl
02123d6650 Fix JS search when html_copy_source is off. 2008-12-07 23:16:57 +01:00
Georg Brandl
13043771f4 Fix package name. 2008-12-06 23:26:40 +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
8225225139 Fix #59: use easy_install -U to upgrade existing versions. 2008-11-27 18:26:24 +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
632a2f0fd6 Add more FAQ entries. 2009-02-18 00:10:32 +01:00
Georg Brandl
53ed60d6dc Add examples for docnames. 2009-02-17 23:08:26 +01:00
Georg Brandl
30fd6faddd Document changes to the app API. 2009-02-17 19:33:46 +01:00
Georg Brandl
c6b6957082 Document self-in-toctree. 2009-02-17 19:24:45 +01:00
Georg Brandl
905ed46696 There is now a `-W` option for sphinx-build that turns warnings into errors.
^
2009-02-17 19:19:09 +01:00
Georg Brandl
82842e8d8e Use INI lexer. 2009-02-17 12:20:09 +01:00
Georg Brandl
d5ea00899c Change html_collapse_toctree setting to an argument of the toctree() callable. 2009-02-16 00:08:08 +01:00
Georg Brandl
21f78a9771 Fix target. 2009-02-15 20:08:31 +01:00
Georg Brandl
10c89799fd Fix #93: note that show-inheritance works with automodule. 2009-02-15 18:52:28 +01:00
Georg Brandl
c3e13cfa9a Add theming test suite, fix a few bugs and doc problems. 2009-02-15 16:10:10 +01:00
Georg Brandl
106ef21629 More templating docs. 2009-02-15 11:38:23 +01:00
Georg Brandl
114df1e0c8 Theming docs, part 2. 2009-02-15 11:03:16 +01:00
Georg Brandl
8e088876cf Theming docs, part 1. 2009-02-15 10:45:46 +01:00
Georg Brandl
25b71e4143 * Add support for theme options.
* Make the right-/stickysidebar alternatives for the default design options.
* Add theme-related options to quickstart.
2009-02-15 01:43:10 +01:00
Georg Brandl
1219e3e73a merge with main 2009-02-14 23:25:30 +01:00
Georg Brandl
54f4da1677 Add docs for absolute image paths feature. 2009-02-14 15:32:41 +01:00
Georg Brandl
364d38fd74 Fix example. 2009-02-14 15:11:25 +01:00
Georg Brandl
143cf90787 Add Finnish translation by Jukka Inkeri. 2009-02-14 15:09:45 +01:00
Georg Brandl
5e1448361f Add FAQ, to be expanded. 2009-02-12 12:50:42 +01:00