Commit Graph

8221 Commits

Author SHA1 Message Date
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
b53b3f72e2 Add changelog. 2008-03-22 20:44:56 +00:00
Georg Brandl
cf7ebde5f8 Mention docutils version requirement. 2008-03-22 20:44:13 +00:00
Georg Brandl
ab34a7dd71 Fix module name. 2008-03-22 19:52:21 +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
0ebca28ac9 Introduce an ugly hack allowing doctest to test multi-statement examples. 2008-03-22 11:47:50 +00:00
Georg Brandl
ac5d8749e9 * Don't "build" dependent files, makes no sense.
* Don't resolve the pickled doctrees, not needed for doctests.
2008-03-22 11:07:12 +00:00
Georg Brandl
3d3547cf52 Only create the index in the HTML builder. 2008-03-22 10:59:26 +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
d980608a58 Remove unicode characters from description. 2008-03-21 17:22:42 +00:00
Georg Brandl
6972d3cac4 Fix arg name. 2008-03-21 17:20:09 +00:00
Georg Brandl
3a111c3ebd Prepare for release. 2008-03-21 15:31:32 +00:00
Georg Brandl
637b1379bc Fix a few overlong lines, and use \t instead of literal tabs. 2008-03-21 15:27:21 +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
b2c8c8752d Actually use the doctest_path setting. 2008-03-21 14:03:25 +00:00
Georg Brandl
8ca2dbe7a7 Give the env to custom descitem parse functions. 2008-03-21 14:02:31 +00:00
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