Georg Brandl
d8c601b4cd
* Allow the ~ prefix on module xrefs.
...
* The parse function for custom descitems must return the full name for x-refing.
2008-03-21 14:00:34 +00:00
Georg Brandl
dd14145ed5
Add the doctest extension. It provides a builder that runs
...
test snippets in the documentation, marked up as doctest snippets
or separate code and output blocks. Providing setup code that
is run but not shown in HTML output is supported.
2008-03-21 13:17:04 +00:00
Georg Brandl
c0a44f7996
* Support \classdescni.
...
* Generate valid highlighting code even if code doesn't end in \n.
2008-03-19 08:00:25 +00:00
Georg Brandl
7b298368d3
Ignore MemoryError while parsing Python source with Python 2.4
...
(it's raised for invalid coding cookies).
2008-03-19 07:45:14 +00:00
Georg Brandl
63cf464e30
Return an exit status != 0 on error.
2008-03-19 07:39:24 +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
be8e106483
Remove debugging remnant.
2008-03-18 19:42:24 +00:00
Georg Brandl
bb3506f564
Add new README, adapt setup.py.
2008-03-18 19:37:05 +00:00
Georg Brandl
02fbceb734
Move converter to its own dir.
2008-03-18 19:34:25 +00:00
Georg Brandl
a1a6016f0f
Move converter to its own dir.
2008-03-18 19:34:11 +00:00
Georg Brandl
d3c0de7d62
Improve handling of exceptions.
2008-03-18 19:17:56 +00:00
Georg Brandl
4eaf9b5da5
Support creating a Makefile in quickstart.
2008-03-18 18:40:44 +00:00
Georg Brandl
39e8da70b9
Fill in some XXXs.
2008-03-18 18:19:21 +00:00
Georg Brandl
e07a6384cb
Add search styles to sphinxdoc style.
2008-03-18 08:09:13 +00:00
Georg Brandl
09b3e75763
Fix searchtools JS.
2008-03-18 08:03:47 +00:00
Georg Brandl
2860e5e920
Fix search template block name.
2008-03-18 07:49:50 +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
2f37a14939
Some pylint fixes.
2008-03-16 13:12:48 +00:00
Georg Brandl
8affe87531
Remove obsolete documents.
2008-03-16 13:06:12 +00:00
Georg Brandl
b1fbe7a2b6
Make the sphinxdoc layout work with IE.
2008-03-16 12:00:01 +00:00
Georg Brandl
e8a6143f8b
sphinx.web is currently broken.
2008-03-16 11:44:35 +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
14da7605e4
Enable :role:title <target> syntax for all xref role types.
2008-03-16 11:18:55 +00:00
Georg Brandl
d739756f2a
Fix autodoc for some conditions where env.autodoc_* is not set.
2008-03-16 11:10:31 +00:00
Georg Brandl
5d253d4293
Don't warn for unknown keywords. Give Python refs a link title.
2008-03-16 11:10:03 +00:00
Georg Brandl
e40037d438
Add language and linenos options to literalinclude directive.
2008-03-16 11:09:32 +00:00
Georg Brandl
06dd99e1a1
Expand the markup chapter a bit.
2008-03-15 09:06:04 +00:00
Georg Brandl
0f0c91875c
Make the linkchecker output usable with Emacs' grep-mode.
2008-03-15 08:02:19 +00:00
Georg Brandl
e886f2c5ae
Move link checker to its own file. Use different user-agent to enable Wikipedia lookup.
2008-03-14 23:47:30 +00:00
Georg Brandl
f2d713c577
Add documentation for autodoc.
2008-03-14 23:35:08 +00:00
Georg Brandl
138ea16594
Add first version of sphinx.ext.autodoc that generates documentation from docstrings.
2008-03-14 23:08:22 +00:00
Georg Brandl
46f7a97c4f
Fix behavior for .. method directives inside a .. class.
2008-03-14 22:39:36 +00:00
Georg Brandl
b5d7a5ff8f
Correctly handle doctest blocks in HTML writer.
2008-03-14 22:35:04 +00:00
Georg Brandl
31e22c0351
Another typo.
2008-03-14 15:41:33 +00:00
Georg Brandl
460d3fdbb7
Fix typo.
2008-03-14 15:40:31 +00:00
Georg Brandl
6d7d1f6e50
Some more documentation.
2008-03-12 21:37:22 +00:00
Georg Brandl
19df48d2cb
Template dirs are relative to the root.
2008-03-12 21:07:53 +00:00
Georg Brandl
6aae7cf9ff
Actually use the Python repository's revision number.
2008-03-09 21:42:38 +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
Georg Brandl
a686a5a03a
Some miscellaneous fixes.
2008-03-09 21:31:52 +00:00
Georg Brandl
c57890b4f4
A leading '~' in a object cross-reference hides the module part.
2008-03-09 21:31:42 +00:00
Georg Brandl
fab35de6a8
Actually honor the "title" value in latex_documents, if present.
2008-03-09 19:55:44 +00:00
Georg Brandl
f2ff0419bd
Add code-block directive, to simplify integrating snippets
...
in other languages, and with line numbers.
2008-03-09 19:45:54 +00:00
Georg Brandl
910e488e39
* Allow registering arbitrary cross-referencing directives/roles.
...
* Allow labels anywhere, and allow giving an explicit caption in :ref: links.
* Some fixes to the sphinxdoc style.
* Add an option to show author information in the output.
* Search user-defined templates in the order they occur in the config
(thanks Nick).
2008-03-09 18:18:41 +00:00
Georg Brandl
f60dfdd231
Add a new experimental style.
2008-03-09 12:01:15 +00:00
Georg Brandl
b223c58904
Fix to load user-provided templates before system-provided ones.
2008-03-09 12:01:03 +00:00
