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
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
Georg Brandl
883fef147e
Add missing endblock directives.
2008-03-09 10:40:27 +00:00
Georg Brandl
89c8e7fd1e
Add more blocks for custom page content.
2008-03-09 10:39:09 +00:00
Georg Brandl
a95a40c748
Add some labels by default; create a master doc in quickstart.
2008-03-08 21:23:54 +00:00
Georg Brandl
265766721e
#2207 : fix if no Pygments available.
2008-02-29 18:19:13 +00:00
Georg Brandl
5c5ee14a22
Two latex writer fixes.
2008-02-27 07:12:29 +00:00
Georg Brandl
87aaa59011
Rename sphinx.addons to sphinx.ext.
2008-02-25 20:18:15 +00:00
Georg Brandl
198c8e7271
Fix if no pygments available.
2008-02-25 20:10:24 +00:00
Georg Brandl
38690f6af9
Use a list.
2008-02-24 07:59:59 +00:00
Georg Brandl
7e47fec07b
Fix config value name.
2008-02-23 22:58:48 +00:00
Georg Brandl
2a435e9fb4
Add coverage builder for Sphinx, written for GHOP by Josip Dzolonga.
2008-02-23 18:47:35 +00:00
Georg Brandl
7d9721dd85
* Allow custom static files to be created for the HTML builder.
...
* Add more block tags to the template, making inheriting them easier.
* Make the HTML stylesheet configurable for html and htmlhelp builder.
* Make the Pygments style configurable.
* Create template and style dirs in quickstart.
2008-02-23 15:24:30 +00:00
Georg Brandl
5740db88e8
Patch #2154 from Amaury: allow '...' in Python snippets; it's often
...
used to indicate some left-out code.
2008-02-21 20:39:50 +00:00
Georg Brandl
92271705fd
Fix the HTML help builder.
2008-02-20 19:43:14 +00:00
Georg Brandl
8dc8280c3c
Ignore nonexisting config settings.
2008-02-10 10:59:05 +00:00
Georg Brandl
a1e379d46c
Add setup.py, add quickstart script.
2008-02-09 23:09:36 +00:00
Georg Brandl
b2ec05e690
More refactoring, this time allowing different file extensions
...
and a different master file. Also fix environment warning reporting
and improve handling of error conditions.
2008-02-01 20:44:17 +00:00
Georg Brandl
8ca7c91443
Add link checker builder, written for GHOP by Thomas Lamb.
2008-02-01 15:49:58 +00:00
Georg Brandl
6adfa8050e
Put doc title and release in the header.
2008-02-01 10:53:24 +00:00
Georg Brandl
4f7a8f3f96
More refactoring:
...
* Move refcounting into an addon module.
* Rename the extension manager to Application and use it throughout.
* Fix some bugs found by pylint.
* Add "ifconfig" addon.
2008-01-27 20:23:25 +00:00
Georg Brandl
cf0dcada71
Fix.
2008-01-22 19:02:47 +00:00
Georg Brandl
923987c0e1
Bump env version because of new config class.
2008-01-21 22:36:32 +00:00
Georg Brandl
b208dd634a
Fix.
2008-01-21 20:39:53 +00:00
Georg Brandl
50da49fab4
Further refactorings, add extensibility API.
2008-01-21 20:20:37 +00:00
Georg Brandl
b09e628b0f
A few refactorings in Sphinx.
2008-01-16 20:27:25 +00:00
Georg Brandl
1fbdc410b7
Armin deserves special mention.
2008-01-11 14:21:06 +00:00
Georg Brandl
fb561d22f6
Add authors and license files.
2008-01-11 14:19:54 +00:00
Georg Brandl
db0bbcb136
Update copyright years and change license to BSD.
2008-01-11 14:18:19 +00:00
Georg Brandl
13107c19d0
Remove parentheses if the occur in :func: etc. roles.
2008-01-11 14:08:11 +00:00
Georg Brandl
acffb90132
Remove mention of WinZip.
2008-01-06 17:33:23 +00:00
Georg Brandl
68f4990b6f
Add access keys to navigation; thanks to Marek.
2008-01-06 17:22:26 +00:00
Georg Brandl
350143494d
Checkin my holiday work:
...
- Add "changes" builder to quickly get an overview over all "versionadded/changed/deprecated" directives for a certain version
- Cross-reference keywords
- Fix some problems in the webapp and the latex writer
2007-12-29 10:58:10 +00:00
Georg Brandl
e77b466281
Further fixes. All produced latex documents now run through pdflatex without errors.
2007-12-16 23:14:24 +00:00
Georg Brandl
fe94305a20
Implement field lists, print warnings instead of raising RuntimeErrors.
2007-12-16 22:10:43 +00:00
Georg Brandl
e4e6d92f0f
Implement sidebar and topic nodes.
2007-12-16 21:55:57 +00:00
Georg Brandl
fbe9ed59cb
Several improvements to the latex builder.
2007-12-16 19:36:23 +00:00
Georg Brandl
d6deb877df
Implement index entries, production lists and the glossary.
2007-12-16 12:20:41 +00:00
Georg Brandl