IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
4,524 Commits 2 Branches 219 Tags 163 MiB
c24cfbaed1
Commit Graph

957 Commits

Author SHA1 Message Date
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
Georg Brandl
b13f61bc42 merge with pv/sphinx-work 2009-04-13 09:45:56 +02:00
Georg Brandl
b349660d95 Add html_show_copyright config val, patch by Wojtek Walczak. 2009-04-09 19:04:44 +00:00
Pauli Virtanen
d9ae7c30cb autosummary: write documentation 2009-04-04 22:05:04 +03:00
Georg Brandl
7a29549a0e Add a FAQ item. 2009-03-31 16:50:09 -05: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
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
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
Georg Brandl
36b21d0570 Clarify what needs to be added to extensions. 2009-02-07 20:38:56 +01:00
Georg Brandl
26ae3f01aa Add a rst_epilog setting, usable for global substitutions. 2009-02-07 19:41:10 +01:00
Georg Brandl
d01410c873 Revert accidental debugging leftover. 2009-02-07 19:35:53 +01:00
Georg Brandl
d60aadc13d Added a `toctree` variable to the templates, and the ability to 
The new ``html_collapse_toctree`` config value can be used to
"collapse" the generated toctree given to the templates.
 2009-02-07 14:13:13 +01:00
Georg Brandl
9517595c70 Add Ukrainian translation, by Stoune. 2009-02-06 17:50:24 +01:00
Georg Brandl
2b1ed08569 Fix #97: redundant wording. 2009-02-06 17:41:41 +01:00
Georg Brandl
4e3c3a43fc The new `trim_footnote_reference_space` config value mirrors 
the docutils config value of the same name and removes the
space before a footnote reference that is necessary for reST
to recognize the reference.
 2009-01-26 23:38:02 +01:00
Georg Brandl
d1e6119461 merge with trunk 2009-01-26 22:44:38 +01:00
Georg Brandl
e974741c74 Added a toctree variable to the templates, and the ability to 
include external links in toctrees.

Patch by Stefan Seefeld.
 2009-01-26 21:57:15 +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
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
d0e0acaaa1 merge in trunk 2009-01-10 20:46:13 +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
34a08b862e Document how autodoc with attributes works. 2009-01-06 00:28:29 +01:00
Georg Brandl
beb987bd5b Basic theme infrastructure. 2009-01-05 20:22:30 +01:00
Georg Brandl
c83d630fd8 Close #52: There is now a `hlist` directive, creating a compact 
list by placing distributing items into multiple columns.
 2009-01-04 22:00:40 +01:00
Georg Brandl
09ccce67a9 Close #33: add manpages for command-line tools. 2009-01-04 21:20:51 +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
9fc2437773 Document new literalinclude options. 2009-01-02 00:32:02 +01:00
Georg Brandl
c80dc58ac1 Rename "object" to "pyobject" and document it. 2008-12-30 15:45:02 +01:00
Georg Brandl
04348edcee New builder for Qt help collections, by Antonio Valentino. 
(This is not finished work yet.)
 2008-12-29 00:51:51 +01:00
Georg Brandl
f13c3a00cd Close #23: Added a `classmethod directive along with method` 
and ``staticmethod``.
 2008-12-29 00:11:06 +01:00
Georg Brandl
d271cc57b2 merge 2008-12-28 21:32:12 +01:00
Georg Brandl
b3d55c3139 Close #4: Added a `:download:` role that marks a non-document file 
for inclusion into the HTML output and links to it.
 2008-12-28 21:30:25 +01:00
Georg Brandl
78dec65bcc Due to popular demand, added a `:doc:` role which directly 
links to another document without the need of creating a
label to which a ``:ref:`` could link to.
 2008-12-28 19:44:54 +01:00
Georg Brandl
83c9f7a849 Improve builder docs a bit. 2008-12-26 20:17:59 +01:00
Georg Brandl
b80d874126 Add text target. 2008-12-25 21:44:38 +01:00
Georg Brandl
a26aa3315f Add html_link_suffix value. 2008-12-25 17:59:32 +01:00
Georg Brandl
f5ea8295cd Fix leftovers. 2008-12-21 00:24:36 +01:00
Georg Brandl
f4b1bb7b9e Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-21 00:11:04 +01:00
Georg Brandl
c74163d0a0 The `toctree directive now supports a :hidden:` flag, 
which will prevent links from being generated in place of
the directive -- this allows you to define your document
structure, but place the links yourself.
 2008-12-20 23:23:39 +01:00
Georg Brandl
f02a90ca6e Add sidebarsourcelink block. 2008-12-20 23:08:26 +01:00
Georg Brandl
a605255413 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-15 19:31:12 +01:00
Georg Brandl
f5cb011e77 The new `html_show_sourcelink` config value can be used to 
switch off the links to the reST sources in the sidebar.
 2008-12-15 13:38:39 +01:00
Georg Brandl
5066f49fbe Add "doctest_global_setup" conf val. 2008-12-15 12:33:13 +01:00
Georg Brandl
7c02f11ec1 Merge bugfixes from 0.5. 2008-12-15 11:12:08 +01:00
Georg Brandl
628adc4d03 Add Italian locale, translation by Sandro Dentella. 2008-12-15 10:21:01 +01:00
Georg Brandl
14b401be1e Merge bugfix from 0.5. 2008-12-07 23:20:45 +01:00
Georg Brandl
733b2b5bc6 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-07 22:36:44 +01:00
Georg Brandl
765ec5c0c3 Add html_add_permalinks config value. 2008-11-30 20:38:59 +01:00
Georg Brandl
50339493c6 Add Sphinx.add_lexer(). 2008-11-30 19:58:29 +01:00
Georg Brandl
2757866655 Allow giving values for dict type config values in the overrides. 2008-11-30 16:33:56 +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
Georg Brandl
4c5e72e306 Reorder builder sections. 2008-11-22 13:34:51 +01:00
Georg Brandl
8c5419662e Add note about needed LaTeX packages. 2008-11-22 13:32:32 +01:00
Georg Brandl
634003f847 Add Slovenian locale, by Rok Garbas. 2008-11-19 18:35:00 +01:00
Georg Brandl
4f8a18d841 Use an explicit language. 2008-11-19 18:31:11 +01:00
Georg Brandl
0f94263a9f Add Brazilian Portuguese locale, by Roger Demetrescu. 2008-11-19 18:28:23 +01:00
Georg Brandl
49858b41f3 #38: fix behavior with unitless image dimensions. 2008-11-16 19:07:36 +01:00
Georg Brandl
22cefe2114 Add quote to front page. 2008-11-16 18:44:54 +01:00
Georg Brandl
b1579af47e A few math experience improvements, inspired by Fredrik Johansson. 2008-11-16 18:44:46 +01:00
Georg Brandl
69853e544e Extensions: Add a link to the Wiki. 2008-11-16 13:32:04 +01:00
Georg Brandl
d7dfb64c0e Allow build without conf.py using -C command line switch. 2008-11-16 13:29:10 +01:00
Georg Brandl
355d29c4e1 #42: fix tracker URL. 2008-11-16 09:05:07 +01:00
Georg Brandl
4342f03986 Add Traditional Chinese locale. 2008-11-13 09:18:55 +01:00
Georg Brandl
bf8d68f83b Add Dutch locale. 2008-11-13 09:16:28 +01:00
Georg Brandl
4f900741b7 Add example for comments. 2008-11-09 19:56:14 +01:00
Georg Brandl
0060e50efa Add todo extension. 2008-11-09 19:46:32 +01:00
Georg Brandl
fb26a2a5fc #14: allow distinct programs for cmdoption directive. 2008-11-09 18:28:36 +01:00
Georg Brandl
7b62fc8f2d Add env-purge-doc event. Add some examples for event usage. 2008-11-09 11:56:40 +01:00
Georg Brandl
1436e8dd4d Add note about inline markup nesting. 2008-11-08 12:11:17 +01:00
Georg Brandl
27ee1ed5d4 Reword index page a bit. 2008-11-06 10:35:55 +01:00
Georg Brandl
7aa1c5eed2 #21: allow short form for seealso arguments. 2008-11-04 21:35:05 +01:00
Georg Brandl
78b1f6e613 Doc tweaks. 2008-11-04 19:51:23 +01:00
Georg Brandl
a41c0ee86c Document -A and -Q switches. 2008-11-04 08:46:28 +01:00
Georg Brandl
e666b6d203 Correct parameter name in example. 2008-11-04 08:20:18 +01:00
Georg Brandl
96caeae56d Update repo location. 2008-11-02 23:52:49 +01:00
Georg Brandl
155411a93d Allow skipping members by event. 2008-11-02 20:04:24 +00:00
Georg Brandl
828b390fba Clarification. 2008-11-02 10:41:38 +00:00
Georg Brandl
f74f8ca7a4 Bring up to date and link to add_config_value(). 2008-11-01 14:54:51 +00:00
Georg Brandl
3715bd90a0 Don't disable alphabetical and roman lists anymore. 2008-10-25 16:53:29 +00:00
Georg Brandl
3206a6ab6f Add a note about substitutions. 2008-10-25 16:00:53 +00:00
Georg Brandl
29a3a86cef Add global citations. #1. 2008-10-25 15:54:34 +00:00
Georg Brandl
88d6b2a960 Fix typo. 2008-10-25 15:34:12 +00:00
Georg Brandl
a857b89a23 UTF-8 isn't mandatory anymore. 2008-10-16 20:31:28 +00:00
Georg Brandl
efd474b296 Add a caveat about LaTeX titles and authors, and properly escape 
a title that comes from the document itself.
 2008-10-16 19:37:57 +00:00
Georg Brandl
516d1a2872 Add "source_encoding" config value. 2008-10-16 19:21:06 +00:00
Georg Brandl
d7e2a48555 Add "source-read" event. 2008-10-16 19:04:45 +00:00
Georg Brandl
00de8e0d36 Use palatino for the Sphinx docs. 2008-09-24 16:18:45 +00:00
Georg Brandl
5e13c56f96 #18: put footnotes at the correct location in the LaTeX writer. 2008-09-24 16:13:36 +00:00
Georg Brandl
0b1f0d045a Converter is now fairly usable for non-Python core projects. 2008-09-24 15:50:37 +00:00
Georg Brandl
47ce40c492 #16: allow referring to figures without explicit text. 2008-09-24 15:36:34 +00:00
Georg Brandl
3d3bcb00df Rename rellinks to linktags. 2008-09-24 11:48:43 +00:00
Georg Brandl
6a7e6315c2 Commit missing doc change. 2008-09-23 21:27:12 +00:00
Georg Brandl
a4cb2e9e7a Add footer element. 2008-09-16 07:00:19 +00:00
Georg Brandl
e0a2159c78 Use Google groups issue tracker instead of abusing the Python tracker. 2008-09-12 16:07:13 +00:00
Georg Brandl
f16dae964a Restructure LaTeX file template: add new "latex_elements" config value 
allowing to customize each part of what is written to the tex file.
 2008-09-12 13:08:52 +00:00
Georg Brandl
83b2fdcf78 Add note how to find source examples. 2008-09-11 23:15:32 +00:00
Georg Brandl
e8ba78c9d8 Add section on conversion from others. 2008-09-09 19:24:08 +00:00
Georg Brandl
7d3539c041 Add default highlight language selection support. 
Add support for recognizing Python 3 console output.
 2008-09-09 19:10:09 +00:00
Georg Brandl
139fbd241b Show in "download" sidebar when documented version isn't released. 2008-09-06 20:18:48 +00:00
Georg Brandl
8c86e44d64 Add polish to language list. 2008-09-06 17:13:49 +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
f0605a40a4 Merged revisions 65640,65675,65699,65701 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65640 | georg.brandl | 2008-08-11 16:11:17 +0200 (Mon, 11 Aug 2008) | 2 lines

  More info in intro.
........
  r65675 | georg.brandl | 2008-08-14 13:53:02 +0200 (Thu, 14 Aug 2008) | 2 lines

  #3546: add missing linebreak.
........
  r65699 | benjamin.peterson | 2008-08-15 23:02:22 +0200 (Fri, 15 Aug 2008) | 4 lines

  rename util.with_testapp to util.with_app; nose was running it

  also make an assert more informative
........
  r65701 | benjamin.peterson | 2008-08-16 00:00:54 +0200 (Sat, 16 Aug 2008) | 1 line

  add some tests for sphinx.application
........
 2008-08-23 15:04:45 +00:00
Georg Brandl
92ba27e0af Fix typo. 2008-08-15 19:11:26 +00:00
Georg Brandl
74d52b40bc Add exclude_dirnames value. 2008-08-10 17:21:08 +00:00
Georg Brandl
b3f1de1bf7 New config value "keep_warnings", default is to discard the from the saved doctrees. 2008-08-10 17:10:31 +00:00
Georg Brandl
e93af0e57c Merged revisions 65566-65567,65623,65625 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65566 | georg.brandl | 2008-08-07 09:11:11 +0000 (Thu, 07 Aug 2008) | 2 lines

  Clarification for the ref role.
........
  r65567 | georg.brandl | 2008-08-07 09:11:25 +0000 (Thu, 07 Aug 2008) | 2 lines

  Rebuild everything if extensions change.
........
  r65623 | georg.brandl | 2008-08-10 11:18:42 +0000 (Sun, 10 Aug 2008) | 2 lines

  Unify handling of LaTeX escaping, and add some more replacements.
........
  r65625 | georg.brandl | 2008-08-10 11:25:41 +0000 (Sun, 10 Aug 2008) | 2 lines

  Make tex escapes a module.
........
 2008-08-10 16:59:27 +00:00
Georg Brandl
ac8a346f45 Add preliminary french locale. 2008-08-10 16:42:29 +00:00
Georg Brandl
74d36acbf7 * Add more generated text to the automatic translation. 
* Remove all locale-dependent text from sphinx.sty, put it into Python files
  to enable message extraction and translation.
* Use babel in the LaTeX output.
* Centralize locations for labels used in every builder.
 2008-08-10 10:00:20 +00:00
Georg Brandl
ce74366033 Add Czech translation by Pavel Kosina, and use Unicode gettext methods throughout. 2008-08-08 14:03:02 +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
aed6d94008 Allow nonwrapped displaymath. 2008-08-07 09:17:50 +00:00
Georg Brandl
6d89feae1e Test suite update for math extension. 2008-08-06 14:57:44 +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
b7b483d01f `Sphinx.add_node()` now takes optional visitor methods for the HTML, 
LaTeX and text translators; this prevents having to manually patch
the classes.
 2008-08-05 10:25:40 +00:00
Georg Brandl
b4c78df0a2 Add intersphinx extension. 2008-08-04 17:31:25 +00:00
Georg Brandl
b4f71aa642 Merged revisions 65283,65303,65316-65317,65372-65375,65377,65380,65483-65485,65494 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65283 | georg.brandl | 2008-07-29 10:07:26 +0000 (Tue, 29 Jul 2008) | 2 lines

  Update ez_setup.py.
........
  r65303 | benjamin.peterson | 2008-07-30 12:35:34 +0000 (Wed, 30 Jul 2008) | 1 line

  add a with_testapp decorator for test functions that passes the TestApp instance in a cleans up after it
........
  r65316 | benjamin.peterson | 2008-07-30 23:12:07 +0000 (Wed, 30 Jul 2008) | 1 line

  make the app for test_markup global to the module
........
  r65317 | benjamin.peterson | 2008-07-30 23:31:29 +0000 (Wed, 30 Jul 2008) | 1 line

  make TestApp.cleanup more aggressive
........
  r65372 | georg.brandl | 2008-08-01 19:11:22 +0000 (Fri, 01 Aug 2008) | 2 lines

  Add more tests, fix a few bugs in image handling.
........
  r65373 | georg.brandl | 2008-08-01 19:28:33 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix oversight.
........
  r65374 | benjamin.peterson | 2008-08-01 19:36:32 +0000 (Fri, 01 Aug 2008) | 1 line

  fix one broken test
........
  r65375 | georg.brandl | 2008-08-01 19:41:11 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix the handling of non-ASCII input in quickstart.
........
  r65377 | georg.brandl | 2008-08-01 19:48:24 +0000 (Fri, 01 Aug 2008) | 2 lines

  Allow REs in markup checks.
........
  r65380 | georg.brandl | 2008-08-01 20:31:18 +0000 (Fri, 01 Aug 2008) | 2 lines

  Don't rely on mtimes being different for changed files.
........
  r65483 | georg.brandl | 2008-08-04 09:01:40 +0000 (Mon, 04 Aug 2008) | 4 lines

  Add an "encoding" option to literalinclude.

  Add tests for include directives.
........
  r65484 | georg.brandl | 2008-08-04 09:11:17 +0000 (Mon, 04 Aug 2008) | 2 lines

  Add changelog entry.
........
  r65485 | georg.brandl | 2008-08-04 09:21:58 +0000 (Mon, 04 Aug 2008) | 2 lines

  Fix markup.
........
  r65494 | georg.brandl | 2008-08-04 16:34:59 +0000 (Mon, 04 Aug 2008) | 2 lines

  Correctly use HTML file suffix in templates.
........
 2008-08-04 17:01:15 +00:00
Georg Brandl
97558dcc06 Add "env-updated" and "missing-reference" events. 
Write inventory file as part of the HTML build.
 2008-08-04 09:54:45 +00:00
Georg Brandl
b4f91a5ce5 #3422: allow changing the signature of functions via a new hook. 2008-07-29 18:30:23 +00:00
Georg Brandl
e90d6f5f80 Remove the opcode directive. 2008-07-23 15:18:00 +00:00
Georg Brandl
4fb3723102 Merged revisions 64733,64743,64755,64795,64803 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64733 | georg.brandl | 2008-07-05 17:04:12 +0200 (Sat, 05 Jul 2008) | 2 lines

  Ask for common extensions in quickstart.
........
  r64743 | georg.brandl | 2008-07-05 18:34:55 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add a direct link to the examples page.
........
  r64755 | georg.brandl | 2008-07-06 07:32:09 +0200 (Sun, 06 Jul 2008) | 2 lines

  Backport r64750.
........
  r64795 | georg.brandl | 2008-07-08 16:48:58 +0200 (Tue, 08 Jul 2008) | 2 lines

  Use correct filename extension in search.
........
  r64803 | georg.brandl | 2008-07-08 20:46:49 +0200 (Tue, 08 Jul 2008) | 2 lines

  Accept class options for modules too.
........
 2008-07-08 18:48:21 +00:00
Georg Brandl
aa74c0b799 automodule now supports module options. 2008-07-08 14:45:44 +00:00
Georg Brandl
5a8779fac3 Merged revisions 64725-64726,64730 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64725 | georg.brandl | 2008-07-05 12:31:43 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add note about :maxdepth: in toctrees and latex.
........
  r64726 | georg.brandl | 2008-07-05 12:55:07 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add object names for e.g. :ivar:.
........
  r64730 | georg.brandl | 2008-07-05 16:34:35 +0200 (Sat, 05 Jul 2008) | 2 lines

  Fix another IE problem.
........
 2008-07-05 14:48:10 +00:00
Georg Brandl
17e7e61778 Merged revisions 64703-64708,64710-64712 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64703 | georg.brandl | 2008-07-04 19:24:00 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix linkcheck builder crash for malformed URLs.
........
  r64704 | georg.brandl | 2008-07-04 19:32:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Add 0.5 compatibility for more admonitions.
........
  r64705 | georg.brandl | 2008-07-04 19:38:37 +0200 (Fri, 04 Jul 2008) | 2 lines

  Remove silly "rubric" restriction in latex writer.
........
  r64706 | georg.brandl | 2008-07-04 19:41:44 +0200 (Fri, 04 Jul 2008) | 2 lines

  Document rubric:: Footnotes behavior.
........
  r64707 | georg.brandl | 2008-07-04 19:45:28 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix XHTML.
........
  r64708 | georg.brandl | 2008-07-04 19:50:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  More XHTML fixes.
........
  r64710 | georg.brandl | 2008-07-04 19:59:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  Copy the html_logo to the output static dir.
........
  r64711 | georg.brandl | 2008-07-04 20:37:43 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix latex code for module names with underscores that have platforms.
........
  r64712 | georg.brandl | 2008-07-04 20:46:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix a crash with nonlocal image URIs.
........
 2008-07-04 18:49:39 +00:00
Georg Brandl
2e698fcb09 Merged revisions 64642-64643,64698 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64642 | georg.brandl | 2008-07-01 23:02:35 +0200 (Tue, 01 Jul 2008) | 2 lines

  #3251: label names are case insensitive.
........
  r64643 | georg.brandl | 2008-07-01 23:24:55 +0200 (Tue, 01 Jul 2008) | 2 lines

  Add a note about decorated functions.
........
  r64698 | georg.brandl | 2008-07-04 12:21:09 +0200 (Fri, 04 Jul 2008) | 2 lines

  Allow setting current module to None.
........
 2008-07-04 14:27:25 +00:00
Armin Ronacher
bfebbfd6f0 Fixed a syntax error in the builder documentation. 2008-06-26 11:13:44 +00:00
Armin Ronacher
11498d0037 Implemented JSONHTMLBuilder and improved JSON handling (it now prefers json from the 2.6 stdlib or simplejson). 2008-06-26 11:11:20 +00:00
Armin Ronacher
95f7883e94 Refactored pickle builder into a SerializingHTMLBuilder and PickleHTMLBuilder. Subclasses can change the serialization format easily. 2008-06-26 09:40:42 +00:00
Georg Brandl
c71f080de8 Add "who uses it" page. 2008-06-23 12:35:22 +00:00
Georg Brandl
8b0f48a38b Add static method support. 2008-06-23 12:04:56 +00:00
Georg Brandl
1e3b8734fd Add a bit on signatures and field lists. 2008-06-23 11:46:10 +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
7c2247f880 Support :noindex: in autodoc directives. 2008-06-22 17:58:05 +00:00
Georg Brandl
002837d7f7 Fix class name. 2008-06-18 18:46:46 +00:00
Georg Brandl
242e343c10 Follow renaming of desc_classname to desc_addname. 2008-06-18 18:33:11 +00:00
Georg Brandl
7d4ce97ec3 Add default_role configuration value. 2008-06-17 10:06:37 +00:00
Georg Brandl
309377fbbf Support inheritance display in autoclass, thanks to mdboom. 2008-06-17 09:24:11 +00:00
Georg Brandl
6b5f4f198a Support splitting the HTML index. 2008-06-17 09:01:26 +00:00
Georg Brandl
1f73e1bee9 Add notes about Unicode and escaping of backslashes. 2008-06-17 07:46:33 +00:00
Georg Brandl
b05861454c Add image format handling. 2008-06-15 14:31:16 +00:00
Georg Brandl
66b5f39bc7 Add html_favicon config value. 2008-06-15 08:48:06 +00:00
Georg Brandl
bd4166c2d6 Add maxdepth for TOCs. 2008-06-12 21:56:06 +00:00
Georg Brandl
a5523402eb Add a preliminary text writer, mainly for producing pydoc-compatible topic help. 2008-06-01 15:27:16 +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
0cf8cc2c5d Provide rest "class" directive as "cssclass". 2008-05-24 19:29:20 +00:00
Georg Brandl
02b529bf52 Add html_short_title and html_show_sphinx config values. 2008-05-24 18:03:56 +00:00
Georg Brandl
28c3199018 Allow subdirs in html_static_path. 2008-05-24 16:40:11 +00:00
Georg Brandl
5eaf2eb29a Add exclude_trees config value. 2008-05-24 16:28:06 +00:00
Georg Brandl
d7fcfb76f8 #2904: fix :func:title <target> behavior. 2008-05-24 16:18:54 +00:00
Georg Brandl
e93f22e84e Add html_use_index flag. 2008-05-23 14:01:53 +00:00
Georg Brandl
0e3dd509e6 Clarify docs for auto directive options. 2008-05-23 13:57:48 +00:00
Georg Brandl
a72511e770 Fix determination of title in HTML help. 2008-05-23 13:41:14 +00:00
Georg Brandl
4a6d98a3fa Add examples section. 2008-05-06 22:21:12 +00:00
Georg Brandl
0bcc9d4655 Minor enhancements to generate_rst. 2008-05-06 18:23:36 +00:00
Armin Ronacher
6e0c582a7b added support for explicit signatures in callables 2008-05-06 18:07:17 +00:00
Georg Brandl
cc6b4ee1ec Add html_file_suffix value. 2008-05-06 14:25:29 +00:00
Georg Brandl
de0bd87731 Support all rst admonitions in LaTeX. 2008-05-06 07:21:46 +00:00
Georg Brandl
9fc2a9b7ad Add `toctree_only` feature to LaTeX builder. 2008-05-04 21:35:03 +00:00
Georg Brandl
5ed30072e3 Rename version to 0.3. 2008-05-04 17:57:11 +00:00
Georg Brandl
3761223d85 * Support for C class names (and const specifiers). 
* Fix handling of describe environment.
 2008-05-04 17:55:35 +00:00
Georg Brandl
548cdc858a Add globbing-style toctree entries. 2008-05-04 16:57:15 +00:00
Georg Brandl
d93b236545 #2726: allow selecting what gets inserted into an autoclass directive. 2008-05-04 09:37:37 +00:00
Georg Brandl
a9d35e3c54 #2656: autodoc now skips inherited members unless the :inherited-members: flag is given. 2008-05-04 09:07:51 +00:00
Georg Brandl
f404b36a0e Fix handling of Verbatim within tables. 2008-05-04 07:43:09 +00:00
Georg Brandl
eeb8a4b27e Use correct OpenSearch base url. 2008-05-03 20:18:53 +00:00
Georg Brandl
06b9960719 Fix OpenSearch description generation. 2008-05-03 20:15:25 +00:00
Georg Brandl
5caa6d01c5 * New LaTeX table handling. 
* Support parts in LaTeX output.
 2008-05-03 18:14:13 +00:00
Georg Brandl
4badbc4f8d Remove note about 0.1. 2008-05-03 09:43:10 +00:00
Georg Brandl
e2158213e8 Allow the configuration directory to be set differently from the source directory. 
Also don't import docutils on importing sphinx.
 2008-05-02 10:32:08 +00:00
Georg Brandl
7ad49d5756 Add exclude_dirs config value. 2008-05-02 09:15:59 +00:00
Georg Brandl
9050ba428e Increase version number. Explain "fully qualified" in the config docs. 2008-05-02 09:05:30 +00:00
Georg Brandl
f91b87b14f Fix typo. 2008-04-28 13:45:58 +00:00
Armin Ronacher
aca631b58f documented change 2008-04-28 13:25:01 +00:00
Georg Brandl
db259e24a4 Put version number in index sidebar. 2008-04-27 20:13:56 +00:00
Georg Brandl
0ee5e39253 Fetch Sphinx version from Sphinx itself. 2008-04-27 20:12:41 +00:00
Georg Brandl
262edb1413 Add logo options, add blocks to sidebar. 2008-04-27 19:43:45 +00:00
Georg Brandl
f7f2cf3a81 Fix markup. 2008-04-27 18:10:48 +00:00
Georg Brandl
0fba8f435e Use OpenSearch for Sphinx docs. 2008-04-27 18:09:49 +00:00
Georg Brandl
a7d088d75b Add OpenSearch capability. 2008-04-27 18:08:55 +00:00
Georg Brandl
1ba3902225 Review templating docs. 2008-04-27 16:35:55 +00:00
Armin Ronacher
ed68fefabe simplified layout template a bit, working on templating documentation 2008-04-27 14:23:11 +00:00
Georg Brandl
e68947dae4 Add a para about section nesting. 2008-04-26 18:01:42 +00:00
Georg Brandl
ec04b2f4ff * Use a customizable title for the docs. 
* Fix up the clumsy index template handling.
 2008-04-19 21:28:24 +00:00
Georg Brandl
c5a4ebe008 :func: et al. should not include parens. 2008-04-19 17:00:31 +00:00
Georg Brandl
ae8813c788 Add new templating API, remove Jinja external and add it to setup.py dependencies. 2008-04-13 18:16:55 +00:00
Georg Brandl
9e485e078e Support `currentmodule` directive, for docs that spread documentation 
for a module's contents over multiple files.
 2008-04-13 17:57:14 +00:00
Georg Brandl
be080234bb Support Sphinx.add_transform(). 2008-04-13 08:20:11 +00:00
Georg Brandl
2571218ab9 Add note about __module__ checking. 2008-04-13 08:09:07 +00:00
Georg Brandl
11f63acd22 Fix :term:title <target>, and make giving multiple cmdoptions possible. 2008-04-07 05:19:26 +00:00
Georg Brandl
7dd56497af Advise to put index directives before the target. 2008-04-06 17:41:51 +00:00
Georg Brandl
ea2f87fc03 Allow the config to act as an extension. 2008-04-06 17:38:55 +00:00
Georg Brandl
b016896c1c Don't swallow toc entries when resolving subtrees. 2008-04-06 16:47:28 +00:00
Georg Brandl
b8369b5c81 Allow new titles in the toctree. 2008-03-30 06:36:20 +00:00
Georg Brandl
d8b8412c84 Adapt extension mod to new indextemplate syntax. 2008-03-28 18:50:03 +00:00
Georg Brandl
5fe73576a5 Support app.add_crossref_type(). 2008-03-28 18:45:32 +00:00
Georg Brandl
eaea91ff39 Add subscription box for the google group. 2008-03-28 13:04:05 +00:00
Georg Brandl
980d22b1a7 Fix HTML. 2008-03-28 07:26:32 +00:00
Georg Brandl
e7dad27b53 Refer to the new Google group. 2008-03-28 07:25:46 +00:00
Georg Brandl
0e1befa4a9 Several fixes in the latex processing. 2008-03-26 12:16:59 +00:00
Georg Brandl
7e2fa2c066 Add a paragraph on special names. 2008-03-25 19:57:09 +00:00
Georg Brandl
2da5b3df46 Expand on the pickle builder. 2008-03-25 19:20:26 +00:00
Georg Brandl
d2ee24fb2f Add Jabber address. 2008-03-25 18:34:11 +00:00
Georg Brandl
aa9ba35f23 Rename pickle builder target. 2008-03-25 18:31:06 +00:00
Georg Brandl
8057b0f80e Rebuild all HTML files in case of a template change. 
Also, record image docnames in order to be able to delete image records from the env.
 2008-03-25 15:22:25 +00:00
Georg Brandl
ba47f283f6 Support the image directive. 2008-03-25 12:32:03 +00:00
Georg Brandl
f264cb6679 Add the changelog to the documentation. 2008-03-23 21:25:19 +00:00
Georg Brandl
08d86db91c Add changelog entry and docs for builder rename. 2008-03-23 19:40:17 +00:00
Georg Brandl
325750aa76 Refer to bugs.python.org. 2008-03-23 17:45:16 +00:00
Georg Brandl
5a131c30a2 Don't install scripts twice. Thanks to lunar. 2008-03-23 17:43:22 +00:00
Georg Brandl
bf3e2cc208 Refreshed logo, by Panos Laganakos. 2008-03-23 15:08:57 +00:00
Georg Brandl
5d272bdd0d Make sphinx compatible with docutils SVN snapshots. 2008-03-23 15:07:15 +00:00
Georg Brandl
5fb481715c Remove outdated info and add an XXX. 2008-03-23 14:33:11 +00:00
Georg Brandl
8be320821a Add versionadded tag. 2008-03-23 08:33:20 +00:00
Georg Brandl
7111855bab Also remove # doctest: directives in presentation output. 2008-03-22 21:21:28 +00:00
Georg Brandl
b82b162729 * sphinx.ext.doctest: Replace <BLANKLINE> in doctest blocks by 
real blank lines for presentation output.
* sphinx.environment: Move doctest_blocks out of block_quotes to
  support indented doctest blocks.
 2008-03-22 21:10:35 +00:00
Georg Brandl
fa089ae583 Add note about blank lines in doctest blocks. 2008-03-22 20:47:27 +00:00
Georg Brandl
cf7ebde5f8 Mention docutils version requirement. 2008-03-22 20:44:13 +00:00
Georg Brandl
6756c8be4d Fixes from Armin. 2008-03-22 13:14:00 +00:00
Georg Brandl
3155163249 Put doctests in "default" by default and update docs for doctest extension. 2008-03-22 13:07:22 +00:00
Georg Brandl
49be523051 Add license and repository info to front page, add comments where sections need to be written. 2008-03-21 18:59:28 +00:00
Georg Brandl
0fc710ed8c Add easy_install to sidebar. 2008-03-21 17:28:37 +00:00
Georg Brandl
3a111c3ebd Prepare for release. 2008-03-21 15:31:32 +00:00
Georg Brandl
5f78bc436b Use Windows-friendlier dirnames. 2008-03-21 15:20:50 +00:00
Georg Brandl
94a868db40 Fix directive parse_node function. 2008-03-21 14:29:39 +00:00
Georg Brandl
5f3df9ecd7 Add a note about sys.path in conf.py. 2008-03-21 14:26:21 +00:00
Georg Brandl
77441d7549 * Add docs for sphinx.ext.doctest. 
* Update parse_node functions.
 2008-03-21 14:06:04 +00:00
Georg Brandl
4d30e0bd40 Make it possible to deactivate the module index. 2008-03-18 19:54:45 +00:00
Georg Brandl
931cd9190a Add doc Makefile. 2008-03-18 19:52:26 +00:00
Georg Brandl
ae09a7f73b Move macro containing blocks to correct file. 2008-03-18 19:44:50 +00:00
Georg Brandl
39e8da70b9 Fill in some XXXs. 2008-03-18 18:19:21 +00:00
Georg Brandl
9f01c4c80a Add a para about sphinx <-> epydoc. 2008-03-18 07:39:40 +00:00
Georg Brandl
ae7273b9ae * Define __file__ during conf.py execution. 
* Make staticpath relative to conf.py dir.
 2008-03-16 20:52:34 +00:00
Georg Brandl
b1fbe7a2b6 Make the sphinxdoc layout work with IE. 2008-03-16 12:00:01 +00:00
Georg Brandl
f552676f9f Fix internal link. 2008-03-16 11:22:40 +00:00
Georg Brandl
ca528099f6 Update documentation, add more content. 2008-03-16 11:19:26 +00:00
Georg Brandl
06dd99e1a1 Expand the markup chapter a bit. 2008-03-15 09:06:04 +00:00
Georg Brandl
f2d713c577 Add documentation for autodoc. 2008-03-14 23:35:08 +00:00
Georg Brandl
6d7d1f6e50 Some more documentation. 2008-03-12 21:37:22 +00:00
Georg Brandl
ccfd92e558 First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00