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
jacob
65ac358d80 rough documentation 2010-06-04 16:13:53 -05:00
Roland Meister
87c3052bb4 Added note for large floating divs to the documentation. 2010-06-03 15:57:38 +02:00
Roland Meister
ef63485c6e Added one more epub_exclude_file. 2010-06-03 15:39:24 +02:00
Robert Lehmann
a1932f62f0 Add gettext builder to Sphinx docs. 2010-05-30 17:02:54 +02:00
Armin Ronacher
475c3ba93b Fixed a C++ bug that caused bad references to be generated. This also 
adds a note on overloads always ending up on the first version of the
method in case more than one is defined.
 2010-05-30 13:51:50 +02:00
Georg Brandl
35f0b555a4 The `toctree callable in templates now accepts a titles_only` keyword argument. 2010-05-30 13:16:26 +02:00
Georg Brandl
f3c706edae The `include` directive now supports absolute paths, which are interpreted as relative to the source directory. 2010-05-30 12:59:42 +02:00
Georg Brandl
0f7072f028 Allow linking to tables just like figures with :ref:. 2010-05-30 12:11:52 +02:00
Georg Brandl
aaa89cbb24 Explain absolute paths in toctree. 2010-05-30 11:58:42 +02:00
Georg Brandl
065fec54f9 Mention more targets in "make help". 2010-05-30 09:06:34 +02:00
Georg Brandl
41e55b92de Add missing targets to Makefile; do not build latex twice for latexpdf target. 2010-05-30 09:02:22 +02:00
Georg Brandl
ac9245de2d Update phony targets. 2010-05-30 08:49:33 +02:00
Armin Ronacher
6613b64726 Added class role docs for JS domain. 2010-05-27 16:18:38 +02:00
Armin Ronacher
a534f39187 Fixed a bug in the C++ domain and documented more 2010-05-27 14:12:24 +02:00
Armin Ronacher
8c388b8b14 Added :js:class: which makes JS documentation a lot more readible 2010-05-27 13:52:02 +02:00
Armin Ronacher
31aed65b6f Usefulified C++ code example 2010-05-27 13:41:16 +02:00
Georg Brandl
8d1235d7ad #419: remove unnecessary mkdir call. 2010-05-26 19:08:15 +02:00
Georg Brandl
c671e81d6c Restore sphinxdoc theme. 2010-05-25 23:59:22 +02:00
Georg Brandl
784e598743 In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option. 2010-05-24 23:14:35 +02:00
Georg Brandl
6dedbfff21 Mention domains in sphinx-contrib. 2010-05-24 22:59:02 +02:00
Georg Brandl
7df8430f2e Merge with http://bitbucket.org/chrism/sphinx/, add latex_show_pagrefs/latex_show_urls config values. 2010-05-24 15:59:05 +02:00
Georg Brandl
4d0facf1e1 Add the "oldcmarkup" extension, to help migrating to 1.0. 2010-05-24 15:12:27 +02:00
Georg Brandl
f6c74a1319 Rename the extlink roles to avoid confusion between :rstdir: and :rst:dir:. 2010-05-24 13:06:55 +02:00
Georg Brandl
9d3e02d238 Add an example. 2010-05-24 13:05:43 +02:00
Georg Brandl
0238e83013 Merge with http://bitbucket.org/tpowers/sphinx/ (rewriting the external/internal distinction code) 
In HTML output, references now get the class ``internal`` if they are internal to the whole project, as opposed to internal to the current page.

The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators.
 2010-05-24 12:57:07 +02:00
Georg Brandl
0f2a0381ba Rename default_domain to primary_domain; give it special semantics. 2010-05-23 16:48:54 +02:00
Georg Brandl
5b7e794e2b #413: Added a way for intersphinx to refer to named labels in other 
projects, and to specify the project you want to link to.
 2010-05-23 13:06:01 +02:00
Georg Brandl
981f134e15 merge with 0.6 2010-05-23 11:17:03 +02:00
Georg Brandl
866d838156 No need to link to dev docs anymore. 2010-05-23 11:16:48 +02:00
Georg Brandl
e83f6a3ecc Fix file name in example. 2010-05-23 11:16:24 +02:00
Georg Brandl
6bc1ce0527 #395: Update Japanese translation URL. 2010-05-22 14:21:01 +02:00
Georg Brandl
0d4bc53e9e Remove debugging leftover. 2010-05-22 14:18:53 +02:00
Georg Brandl
529d3f5329 #404: Make `\and work properly in the author field of the latex_documents` setting. 2010-05-22 14:15:39 +02:00
Georg Brandl
c8c703805c merge with 0.6 2010-05-22 12:59:18 +02:00
Georg Brandl
d1027d6057 Add json target. 2010-05-22 11:40:52 +02:00
Georg Brandl
f5ede38405 #406: mention rst2pdf integration in intro. 2010-05-22 11:11:32 +02:00
Georg Brandl
ae05fc5570 #416: Added Croatian translation, thanks to Bojan Mihelač. 2010-05-22 10:29:55 +02:00
Georg Brandl
28b337dd0c merge 2010-04-18 09:41:44 +02:00
Georg Brandl
722f9ac329 merge with trunk 2010-04-17 13:00:19 +02:00
Georg Brandl
020410f20b merge with 0.6 2010-04-17 12:57:38 +02:00
Georg Brandl
138fc5f7bd Use appropriate interpolation char. 2010-04-17 12:35:21 +02:00
Georg Brandl
f4f3066581 Use the new rst domain in the sphinx docs. 2010-04-17 10:39:51 +02:00
Georg Brandl
541e30b36e Cleanup trailing whitespace and fix a few nits with the rst domain. 2010-04-17 10:29:14 +02:00
Leontius Adhika Pradhana
a097525e15 Added documentation... and removed another stray debug line. 2010-04-16 03:55:18 +08:00
Georg Brandl
b2a7db4a81 Review of JS domain. Adapt coding style a bit. 2010-04-08 21:33:03 +02:00
Georg Brandl
63289cba33 Rename rst_prologue to rst_prolog and document it. 2010-04-07 13:03:34 +02:00
Georg Brandl
d7f1aeba8c Review changes from http://bitbucket.org/tpowers/sphinx/ and add docs. 2010-04-07 13:02:03 +02:00
Georg Brandl
3a61ec646f #349: Add Turkish translation, thanks to Firat Ozgul. 2010-04-07 11:29:32 +02:00
Georg Brandl
3c9619ac4b Add explicit hint about compiling message catalogs. 2010-04-06 19:31:35 +02:00
Daniel Neuhäuser
92027ce19f Merge with sphinx-domains. 2010-04-06 13:16:27 +00:00
Georg Brandl
751e02c767 merge with trunk 2010-04-06 09:23:03 +02:00
Georg Brandl
517b045f86 merge with 0.6 2010-04-06 09:21:22 +02:00
Georg Brandl
454c9d3b9e #354: add link to rst2pdf manual. 2010-04-04 20:04:44 +02:00
Georg Brandl
aa08703a07 Fix file name where example docs are located. 2010-04-04 19:04:01 +02:00
Daniel Neuhäuser
ae0d464fb1 Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields. 2010-03-31 15:15:43 +00:00
Daniel Neuhäuser
5831add5bb Added a :js:attribute:: directive as well as a :js:attr: role to describe attributes of javascript objects. 2010-03-30 22:22:57 +00:00
Daniel Neuhäuser
8cbdf1ec34 It is now possible to use the js:function:: directive for methods. 2010-03-30 21:50:48 +00:00
Daniel Neuhäuser
9d53f460ea Added a js:data directive/role to describe/refer to global variables/constants. 2010-03-30 19:39:18 +00:00
Daniel Neuhäuser
25b8e87fee Added a :js:func: role to refer to functions described with the js:function:: directive. 2010-03-30 19:14:01 +00:00
Daniel Neuhäuser
9837a08294 Added a JavaScript domain and a js:function directive. 2010-03-30 18:40:46 +00:00
Georg Brandl
a5a08531ee merge with 0.6 2010-03-16 08:53:12 +01:00
Georg Brandl
1ea64352fe A bit more tutorial. 2010-03-14 19:46:54 +01:00
Georg Brandl
79f30848c2 Add link to inline markup spec. 2010-03-14 14:31:45 +01:00
Georg Brandl
1998065b4f Add minimal documentation for the C++ domain. 2010-03-09 19:38:49 +01:00
Georg Brandl
c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl
79e824d96a Add shortcut for SPHINXOPTS. 2010-03-01 22:31:17 +01:00
Georg Brandl
4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +01:00
Georg Brandl
a479d56b24 Move inline markup description to domains page. 2010-03-01 14:53:30 +01:00
Georg Brandl
3e9182550a Review markup chapter. 2010-03-01 14:37:31 +01:00
Georg Brandl
a83f9e7686 Make it clear that the default for "collapse" is True. 2010-02-28 19:54:25 +01:00
Georg Brandl
9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +01:00
Georg Brandl
0ee675b7cf Update blurb in setup.py and on the index page, link directly to tutorial.rst from index. 2010-02-28 23:12:00 +01:00
Georg Brandl
700c831ae7 Add a bit more info. 2010-02-28 23:03:38 +01:00
Georg Brandl
2cbe10086f Rename tutorial, add example for image substitution. 2010-02-28 23:03:16 +01:00
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
7f1eafb9a3 Re-export docutils .. class:: as .. rst-class:: and un-document .. cssclass::. 2010-02-28 19:30:30 +01:00
Georg Brandl
dc84392d22 List all docutils directives with short descriptions and links to the reference. 2010-02-28 17:42:41 +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
3d01c2c95f #282: Added a "nitpicky" mode that emits warnings for all missing references. 
It is activated by the ``-n`` command-line switch or the ``nitpicky`` config value.
 2010-02-28 12:13:55 +01:00
Georg Brandl
a31e7e2f5d #187: Added support for source ordering of members in autodoc, with `autodoc_member_order = 'bysource'`. 2010-02-28 11:39:13 +01:00
Georg Brandl
9a316a21a0 merge with trunk 2010-02-28 10:21:00 +01:00
Georg Brandl
adca1e02b0 Apply some changes to agogo, contributed by Florian Diesch. 2010-02-28 09:36:27 +01:00
Georg Brandl
5d56b325c1 merge 2010-02-27 23:27:16 +01:00
Georg Brandl
036a399011 merge with trunk 2010-02-27 23:14:19 +01:00
Georg Brandl
76eb148770 Add app.override_domain(). 2010-02-27 23:13:51 +01:00
Georg Brandl
832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +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
5c92da1c12 Allow giving no authors. 2010-02-25 22:21:41 +01:00
Georg Brandl
51e8de3446 Update phony target lists. 2010-02-25 22:03:27 +01:00
Georg Brandl
fab92b215a Added `autodoc_default_flags` config value, which can be used 
to select default flags for all autodoc directives.
 2010-02-21 22:16:06 +01:00
Georg Brandl
750c3622fd Add some versionadded tags. 2010-02-21 21:57:58 +01:00
Georg Brandl
94e47ff6d8 merge with trunk 2010-02-21 21:49:54 +01:00
Georg Brandl
700dda624e merge with 0.6 2010-02-21 21:48:09 +01:00
Georg Brandl
b81b7a0463 Remove docs for autosummary features that are not actually in 0.6. 2010-02-21 21:46:07 +01:00
Georg Brandl
121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl
d305ab2bd0 Add link to Qt help. 2010-02-20 19:57:13 +01:00
Georg Brandl
454ecf80a4 Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX. 2010-02-20 01:13:23 +01:00
Georg Brandl
b9dd04176f pygments_style for HTML is selected by the theme. 2010-02-19 19:58:35 +01:00
Georg Brandl
68ecaea045 merge with trunk 2010-02-19 10:36:59 +01:00
Georg Brandl
3c89a7475b merge with http://bitbucket.org/rolmei/sphinx-epub/. 2010-02-19 10:20:07 +01:00
Georg Brandl
52698469ac Make docs latex-writable again. 2010-01-17 23:24:40 +01:00
Georg Brandl
1bce0d7e6a Fix some XXXes. 2010-01-17 19:21:04 +01:00
Georg Brandl
538886ab94 A bit of domain documentation. 2010-01-17 19:16:18 +01:00
Georg Brandl
1a7403bed8 Add doc for new doc field syntax. 2010-01-17 19:05:19 +01:00
Georg Brandl
baf0087f3a merge with trunk 2010-01-17 18:29:16 +01:00
Georg Brandl
5a9a454631 Added `needs_sphinx config value and Sphinx.require_sphinx` application API function. 2010-01-17 18:24:35 +01:00
Georg Brandl
31c5290fb8 Clean up conf.py file for the docs. 2010-01-17 18:16:14 +01:00
Georg Brandl
e4f4cd2bf9 merge with trunk 2010-01-17 17:00:37 +01:00
Georg Brandl
744a519c92 Add single-file HTML builder. Closes #151. 2010-01-17 16:48:02 +01:00
Georg Brandl
11089371b1 Simplify makefile. 2010-01-17 15:33:28 +01:00
Georg Brandl
5d40d8bd63 merge with trunk 2010-01-17 14:24:24 +01:00
Georg Brandl
c98236bc61 Finish new doc field handling implementation. 2010-01-17 12:05:44 +01:00
Georg Brandl
f5c08cbb60 First step toward better handling of doc fields. 2010-01-15 00:00:37 +01:00
Georg Brandl
5705adc9d5 Document three new appapi functions. 2010-01-14 22:28:03 +01:00
Georg Brandl
27f85a8dab Fix style inconsistency. 2010-01-14 21:33:30 +01:00
Georg Brandl
e2b5248177 Fix typo. 2010-01-14 20:42:10 +01:00
Georg Brandl
ba13060ebe Fix docs of emit_firstresult(). 2010-01-14 11:18:28 +01:00
Georg Brandl
edb89b1940 Add the "viewcode" extension. 2010-01-13 23:53:01 +01:00
Georg Brandl
cbbae81e8f Add html-collect-pages event. 2010-01-13 23:42:58 +01:00
Georg Brandl
a7d9a4894b merge with 0.6 2010-01-12 23:40:26 +00:00
Georg Brandl
fa00d30daf Add link to rst2pdf generated version. 2010-01-12 21:11:20 +00:00
Georg Brandl
8bb4d4320d merge with 0.6 2010-01-12 10:47:29 +00:00
Roland Meister
a880aa8f70 Added transform for visible links. 2010-01-10 21:14:19 +01:00
Roland Meister
0a1f09c9cf Added the epub_tocdepth configuration option. 2010-01-09 11:19:41 +01:00
Georg Brandl
2a2a66a923 merge with trunk 2010-01-08 18:55:35 +01:00
Georg Brandl
c80f52dfbf Added `tab-width option to literalinclude` directive. 2010-01-08 18:36:58 +01:00
Georg Brandl
c227fc2720 merge with trunk (and remove debugging leftover from test layout.html template) 2010-01-07 21:51:23 +01:00
Georg Brandl
03b9d79b34 Fix compatibility with blocks in the old sidebar scheme: blocks cannot be used in included templates. Deprecate the blocks accordingly. 2010-01-07 21:49:31 +01:00
Georg Brandl
b1c937f0d9 merge with trunk (not working perfectly yet) 2010-01-07 21:41:03 +01:00
Georg Brandl
5e17487b74 merge with trunk 2010-01-07 19:19:58 +01:00
Georg Brandl
cbd75346fd merge with trunk 2010-01-07 19:17:45 +01:00
Georg Brandl
a43738e47a merge with trunk 2010-01-07 19:07:50 +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
c9345b33b2 `html_static_path` can now contain single file entries. 
Exclusion of static path files is not yet implemented.

HG: Bitte gib eine Versions-Meldung ein. Zeilen beginnend mit 'HG:' werden entfernt.
HG: Leere Versionsmeldung wird das Übernehmen abbrechen.
HG: --
HG: Benutzer: Georg Brandl <georg@python.org>
HG: branch 'default'
HG: added tests/root/_static/excluded.css
HG: added tests/root/_static/subdir/foo.css
HG: added tests/root/templated.css_t
HG: Geändert CHANGES
HG: Geändert doc/config.rst
HG: Geändert sphinx/builders/html.py
HG: Geändert sphinx/util/__init__.py
HG: Geändert tests/root/_static/README
HG: Geändert tests/root/conf.py
HG: Geändert tests/test_build_html.py
 2010-01-07 16:20:52 +01:00
Georg Brandl
ebe51c181e Add a "how do I do google analytics" entry, thanks tonfa. 2010-01-07 15:33:47 +01:00
Georg Brandl
db5845fccf Sharpen the thumbnails a bit. 2010-01-07 15:10:11 +01:00
Georg Brandl
4b8b3fa631 Fix-up text. 2010-01-07 14:27:37 +01:00
Georg Brandl
368ecbb0fd Added new HTML theme `haiku`, inspired by the Haiku OS user guide. 2010-01-07 14:16:53 +01:00
Georg Brandl
f8ca88ebbd Fix bogus module prefix for template variables. 2010-01-07 13:59:06 +01:00
Georg Brandl
2acec48b86 merge with 0.6 2010-01-06 15:51:30 +01:00
Georg Brandl
6f1a3b5c3f Fix config value names. 2010-01-06 15:51:02 +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
c3c3f739af Remove the deprecated `exclude_dirs` config value. 2010-01-06 15:54:34 +01:00
Georg Brandl
57c2b553ae Add preview images for nature theme. 2010-01-03 19:44:40 +01:00
Georg Brandl
f73cbe8afa merge with 0.6 2010-01-03 19:44:21 +01:00
Georg Brandl
443eb4e594 Add "nature" theme, as used by PIP and distribute. 2010-01-03 19:40:07 +01:00
Georg Brandl
a5f1df6946 Mark code blocks as Python. 2010-01-03 19:38:17 +01:00
Georg Brandl
7bafd3d553 merge with 0.6 2010-01-03 16:04:23 +01:00
Georg Brandl
276fc659b0 #162: add link to sphinx.pocoo.org/latest. 2010-01-03 15:36:51 +01:00
Georg Brandl
c8835d970b Added `alt option to graphviz` extension directives. 2010-01-03 12:02:31 +01:00
Georg Brandl
4d2a052c5f Note about linkcheck builder. 2010-01-03 10:24:49 +01:00
Georg Brandl
ae4a1bbc59 Fix link. 2010-01-03 10:22:03 +01:00
Georg Brandl
d32bd22ae7 #309: The `graphviz` extension can now output SVG instead of PNG 
images, controlled by the ``graphviz_output_format`` config value.
Patch by Henrique Bastos.
 2010-01-02 21:38:27 +01:00
Georg Brandl
faeec5cbbb merge with trunk 2010-01-02 21:03:56 +01:00
Georg Brandl
ed78dc7ff0 merge with 0.6 2010-01-02 20:54:59 +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
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
32437e45bd merge with 0.6 2010-01-02 00:49:51 +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
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
e5561f9b1b Add cross-reference. 2009-12-29 12:41:35 +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
Georg Brandl
5d0812fb91 merge with trunk 2009-12-28 19:49:57 +01:00
Georg Brandl
f37dcb25da merge with epub fork 2009-12-28 19:00:48 +01:00
Roland Meister
6ced1ce311 Disable embedded css for embedded builders. 
Note: this change also affects all other embedded builders (but only for the Shinx doc itself).
 2009-12-28 17:16:19 +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
0238b8322d merge with 0.6 2009-12-24 13:32:16 +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
8533c4cb98 merge with trunk 2009-11-16 15:03:20 +01:00
Georg Brandl
407b41536d merge with trunk 2009-11-09 00:37:42 +01:00
Georg Brandl
5590675955 merge with 0.6 2009-11-09 00:33:49 +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
d12ad380f2 Finish renaming description units to object (description)s. 2009-10-27 19:58:40 +01:00
Georg Brandl
13478a4986 Make "make check" happy. 2009-10-26 09:56:14 +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
a51e3a4129 Add missing extension. 2009-10-08 09:14:01 +02:00
Georg Brandl
6b772c5640 merge with trunk 2009-09-09 21:57:49 +02: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
Georg Brandl
0792ad7498 The `toctree() callable in templates now has a maxdepth` 
keyword argument to control the depth of the generated tree.

Also add tests for that callable.
 2009-09-09 15:56:52 +02:00
Georg Brandl
eff5270219 Add pointer to `toctree()` in FAQ. 2009-09-09 15:43:58 +02:00
Georg Brandl
023cae4e47 Add link to sphinx-pypi-upload package. 2009-09-09 11:00:54 +02:00
Georg Brandl
0136520b7c Add scrolls theme to the docs. 2009-09-08 21:49:27 +02:00
Georg Brandl
efa4678cfd Add some XXX comments to places where work is needed. 2009-09-08 12:07:11 +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
fa7f8812cd More refactoring for language-independent domain support. 
* Renamed "desc"ription unit to "object" wherever possible.
* Added standard x-ref types to a StandardDomain which is always consulted.
* Split domains module into a subpackage.
* Removed additional_xref_types in favor of new directive classes in StandardDomain.
* Implemented x-ref inventory version 2, for all object types.
* Added env.doc_read_data which is for temporary data stored while reading.
* Minimally updated extension tutorial.
* Started to implement changes to interactive search.
* Test suite passes again.
 2009-09-07 22:52:26 +02:00
Georg Brandl
9fce647b14 merge with 0.6 2009-09-03 18:24:04 +02:00
Georg Brandl
3e91b3cd64 merge 2009-09-02 17:32:48 +00:00
Georg Brandl
a734207eea fix markup 2009-08-26 14:30:23 +00:00
Georg Brandl
d3b0d6a105 merge with trunk 2009-08-09 22:46:16 +02:00
Georg Brandl
137f37b2fc merge with 0.6 2009-08-06 23:03:49 +02:00
Georg Brandl
c32186282f #222: Allow the "Footnotes" header to be translated. 2009-08-06 22:48:14 +02:00
Georg Brandl
3352493642 merge pre-domain state with tip from 0.6 2009-08-06 21:36:57 +02:00
Georg Brandl
86686262bd merge with 0.6 2009-08-05 00:04:39 +02:00
Georg Brandl
0516082799 Add link to db2rst. 2009-08-04 22:39:17 +02:00
Georg Brandl
af8fe705a2 Added Catalan translation, thanks to Pau Fernández. 2009-07-29 16:39:06 +00:00
Georg Brandl
e766c576c0 Put traditional theme at the bottom. 2009-11-16 14:50:51 +01:00
Georg Brandl
c68f51305d Add scrolls theme to the docs. 2009-09-08 21:49:27 +02:00
Georg Brandl
03aaed913b Add new theme "agogo", by Andi Albrecht. 2009-11-16 14:48:52 +01:00
Pauli Virtanen
8122339c95 Add GNOME Devhelp builder 2009-06-27 19:49:51 +03:00
Pauli Virtanen
9043aeb723 autosummary: generate stub pages recursively 2009-06-19 16:57:43 +03:00
Georg Brandl
041d7c37a5 #116: Added `html_output_encoding` config value. 2009-06-16 22:19:51 +02: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
fdf4bf4154 merge with 0.6 2009-06-15 18:36:22 +02:00
Georg Brandl
8820e99440 Added `titlesonly option to toctree` directive. 2009-06-15 18:05:07 +02:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
7d56682ad7 merge with 0.6 2009-06-15 17:33:56 +02:00
Georg Brandl
f3860b1af9 Update URL for html2rest. 2009-06-10 08:45:22 +02:00
Georg Brandl
279dd4fa41 Builder.load_env is no more. 2009-07-26 15:00:18 +02:00
Georg Brandl
43f475b74e Fix long lines. 2009-07-05 12:28:45 +02:00
Georg Brandl
c02b7149aa Move domain-specific code around a bit; builtin domains are now completely in sphinx.domains. Test suite does not pass yet. 2009-07-05 12:24:27 +02:00
Georg Brandl
4e535fec91 #193: Added a `visitedlinkcolor` theme option to the default theme. 2009-06-05 10:41:02 +02:00
Georg Brandl
fb0791bdfc Added the `prepend and append` options to the 
``literalinclude`` directive.
 2009-06-04 17:57:58 +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
df75924602 merge with 0.6 2009-05-31 18:59:36 +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
7749debcdc Reformat autosummary docs. 2009-05-17 12:29:38 +02:00
Georg Brandl
8bb67b9bf0 merge with 0.6 2009-05-17 12:24:17 +02:00
Georg Brandl
0a3d0495a1 merge with pv/sphinx-work 2009-05-17 12:24:04 +02:00
Georg Brandl
d2bdbb0ee5 #168: fix code. 2009-05-17 12:20:04 +02:00
Georg Brandl
95dbaa5360 merge with 0.6 2009-05-16 12:49:58 +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
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
6702234eac Remove testing markup. 2009-05-03 10:25:40 +02:00
Georg Brandl
40a044b6da Fix markup. 2009-05-03 10:24:28 +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
Georg Brandl
7e53d3f71b Next version will be 1.0. 2009-04-29 12:55:03 +02:00
Georg Brandl
2376d259ef Added simplified Chinese locale. 2009-04-28 23:21:07 +02:00
Georg Brandl
7468998a28 merge with 0.6 2009-04-28 21:43:40 +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
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