Commit Graph

329 Commits

Author SHA1 Message Date
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
0de312b96f Direct posting to sphinx-dev is not possible anymore. 2010-01-02 00:09:01 +01:00
Georg Brandl
0745637e69 Correct info about jsmath_path if given relative. 2010-01-01 23:54:45 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
023b41b391 #296: fix copy-paste oversight. 2009-12-24 13:29:11 +01:00
Georg Brandl
98437cfd28 Fix typo. 2009-12-01 21:04:46 +01:00
Georg Brandl
598f2dda3a Add link to Japanese translation of the docs. 2009-11-08 19:36:16 +01:00
Georg Brandl
77c5026198 Add link to matplotlib's sampledoc, because I suck at writing tutorials. 2009-11-08 18:20:53 +01:00
Georg Brandl
adad88b429 Add notes on rst2pdf pdf builder. 2009-11-08 16:54:06 +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
a51e3a4129 Add missing extension. 2009-10-08 09:14:01 +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
Georg Brandl
a734207eea fix markup 2009-08-26 14:30:23 +00:00
Georg Brandl
c32186282f #222: Allow the "Footnotes" header to be translated. 2009-08-06 22:48:14 +02:00
Georg Brandl
0516082799 Add link to db2rst. 2009-08-04 22:39:17 +02:00
Georg Brandl
269345a0f3 Clarify and fix typo. 2009-06-16 21:19:15 +02:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
f3860b1af9 Update URL for html2rest. 2009-06-10 08:45:22 +02:00
Georg Brandl
92eef1b2e5 Set the default encoding to `utf-8-sig` to handle files with a
UTF-8 BOM correctly.
2009-05-31 18:58:28 +02:00
Georg Brandl
d2bdbb0ee5 #168: fix code. 2009-05-17 12:20:04 +02:00
Georg Brandl
92f420bd22 Add more interop links. 2009-05-13 09:15:29 +02:00
Georg Brandl
041a491df7 Remove testing leftover. 2009-05-03 10:36:27 +02:00
Georg Brandl
770f716fc0 #29: Don't generate visible "-{-}" in option lists in LaTeX. 2009-04-28 21:28:29 +02:00
Georg Brandl
7a29549a0e Add a FAQ item. 2009-03-31 16:50:09 -05:00
Sebastian Wiesner
73942678c8 #122: proxy support for intersphinx 2009-03-19 15:49:03 +01:00
Georg Brandl
5469dfe4e6 Add Russian translation, by Alexander Smishlajev. 2009-03-24 09:00:45 +00: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
989f8a593d Add link to Glenn's SCons script repo. 2009-03-15 23:43:09 +01:00
Georg Brandl
4de4dcccd4 #123: The `glossary directive now supports a :sorted:`
flag that sorts glossary entries alphabetically.
2009-03-15 23:34:19 +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
ed26bfa30e Remove testing text. 2009-03-05 10:05:27 +01:00
Georg Brandl
51265dfe3f #114: Added an `abbr` role to markup abbreviations and acronyms. 2009-03-05 09:48:55 +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
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