Commit Graph

59 Commits

Author SHA1 Message Date
Georg Brandl
f36592e418 Begin the Great Refactoring of the docs.
* Move sphinx-build option description from intro to a new document.
* Move toctree information to a new document in markup/.
* Add a tutorial document placed after intro. Begin filling it in.
2010-02-28 22:00:22 +01:00
Georg Brandl
0feb7dacf2 Add a bit more content to the reST primer, and add links to the reST reference docs for all constructs. 2010-02-28 17:24:55 +01:00
Georg Brandl
04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +01:00
Georg Brandl
07a658e50c Remove hand-written manpages, add rst documents to be built with the manpage builder. 2010-02-25 22:22:01 +01:00
Georg Brandl
121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl
baf0087f3a merge with trunk 2010-01-17 18:29:16 +01:00
Georg Brandl
31c5290fb8 Clean up conf.py file for the docs. 2010-01-17 18:16:14 +01:00
Georg Brandl
c98236bc61 Finish new doc field handling implementation. 2010-01-17 12:05:44 +01:00
Georg Brandl
edb89b1940 Add the "viewcode" extension. 2010-01-13 23:53:01 +01:00
Georg Brandl
b1c937f0d9 merge with trunk (not working perfectly yet) 2010-01-07 21:41:03 +01:00
Georg Brandl
2f09d24472 The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.
That means that the builtin sidebar contents can be included only selectively.
2010-01-07 17:56:09 +01:00
Georg Brandl
ab7ac64e1a Add new universal config value `exclude_patterns`, with glob-style exclude patterns.
This makes the old ``unused_docs``, ``exclude_trees`` and ``exclude_dirnames`` obsolete.
2010-01-06 15:48:39 +01:00
Georg Brandl
faeec5cbbb merge with trunk 2010-01-02 21:03:56 +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
47ccbccc62 merge with 0.6 2010-01-01 14:10:48 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
f3a2854ba9 merge with trunk 2009-12-31 18:40:58 +01:00
Georg Brandl
24fb46226f Review of epub builder. Add a separate "epub_theme" config value for selecting a different theme. 2009-12-29 12:32:42 +01:00
Roland Meister
eee47685fa Activated html_theme 'epub' 2009-12-28 17:11:15 +01:00
Roland Meister
706e12da65 Initial import from local repository 2009-12-28 17:09:09 +01:00
Georg Brandl
a51e3a4129 Add missing extension. 2009-10-08 09:14:01 +02:00
Georg Brandl
b4ef4bd670 app: allow giving the localized object name when adding new object types. 2009-09-08 00:04:05 +02:00
Georg Brandl
ebcf18d9c3 Added the `latex_docclass` config value and made the "twoside"
documentclass option overridable by "oneside".
2009-06-04 17:50:37 +02:00
Georg Brandl
e46e989d8b No need to use extlinks in conf.py. 2009-05-02 20:48:30 +02:00
Georg Brandl
58da7a84fd Added the `extlinks` extension. 2009-05-02 20:38:45 +02:00
Pauli Virtanen
d9ae7c30cb autosummary: write documentation 2009-04-04 22:05:04 +03:00
Georg Brandl
d3a7f004f0 Oops. 2009-02-20 11:09:54 +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
11a7ed8c49 merge with mq 2009-01-10 22:19:40 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
mq
ab4c11f641 add modindex_common_prefix config value 2009-01-10 21:54:26 +01:00
Georg Brandl
4d345c8de3 Split stylesheets into basic, default and sphinxdoc. 2009-01-10 20:45:45 +01:00
Georg Brandl
ec392f4888 Add Pygments style selection to theming. 2009-01-10 19:14:01 +01:00
Georg Brandl
beb987bd5b Basic theme infrastructure. 2009-01-05 20:22:30 +01:00
Georg Brandl
5df8e162f9 Fix a few remaining copyrights and add 2009 to license. 2009-01-04 14:39:36 +01:00
Georg Brandl
4f8a18d841 Use an explicit language. 2008-11-19 18:31:11 +01:00
Georg Brandl
0060e50efa Add todo extension. 2008-11-09 19:46:32 +01:00
Georg Brandl
00de8e0d36 Use palatino for the Sphinx docs. 2008-09-24 16:18:45 +00:00
Georg Brandl
87a05a41cb Merged revisions 66061,66069 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r66061 | georg.brandl | 2008-08-30 11:43:20 +0200 (Sat, 30 Aug 2008) | 2 lines

  Show last released version in built docs.
........
  r66069 | georg.brandl | 2008-08-30 15:21:40 +0200 (Sat, 30 Aug 2008) | 2 lines

  XeTeX fix by Markus Gritsch.
........
2008-08-30 21:56:43 +00:00
Georg Brandl
c21ff79a8b English is nice for the official docs nevertheless. 2008-08-08 11:00:29 +00:00
Georg Brandl
a7cfb52ab6 Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
Georg Brandl
26d724cb6d Merged revisions 65532,65546-65547,65550-65551 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65532 | georg.brandl | 2008-08-04 22:35:07 +0000 (Mon, 04 Aug 2008) | 2 lines

  Add a test file for misc. markup and fix a doc bug.
........
  r65546 | georg.brandl | 2008-08-05 09:55:20 +0000 (Tue, 05 Aug 2008) | 2 lines

  Show an indication while downloading the search index.
........
  r65547 | georg.brandl | 2008-08-05 10:07:50 +0000 (Tue, 05 Aug 2008) | 2 lines

  Fix an indentation problem in production lists. #3477.
........
  r65550 | georg.brandl | 2008-08-05 16:21:34 +0000 (Tue, 05 Aug 2008) | 2 lines

  Remove unused interface.js.
........
  r65551 | georg.brandl | 2008-08-06 08:48:21 +0000 (Wed, 06 Aug 2008) | 2 lines

  Don't try to remove a nonexisting static dir.
........
2008-08-06 14:46:11 +00:00
Georg Brandl
5941814c4a Add math support to Sphinx. 2008-08-06 13:04:14 +00:00
Georg Brandl
c1bedfc105 Add general docstring processing support with a new event in autodoc. 2008-06-22 21:02:50 +00:00
Georg Brandl
242e343c10 Follow renaming of desc_classname to desc_addname. 2008-06-18 18:33:11 +00:00
Georg Brandl
2b0e015fcc Add html-page-context event for customizing the template context. 2008-05-31 16:14:36 +00:00
Georg Brandl
9fc2a9b7ad Add `toctree_only` feature to LaTeX builder. 2008-05-04 21:35:03 +00:00
Georg Brandl
eeb8a4b27e Use correct OpenSearch base url. 2008-05-03 20:18:53 +00:00
Georg Brandl
5caa6d01c5 * New LaTeX table handling.
* Support parts in LaTeX output.
2008-05-03 18:14:13 +00:00
Georg Brandl
0ee5e39253 Fetch Sphinx version from Sphinx itself. 2008-04-27 20:12:41 +00:00