Commit Graph

47 Commits

Author SHA1 Message Date
Georg Brandl
9708319f5c docs: fix some broken links 2014-01-13 00:05:22 +01:00
Georg Brandl
9d25862700 add link to "write the docs", move hosting chapter to home page 2014-01-12 12:44:36 +01:00
Georg Brandl
2b6dc512b8 doc intro: add a pointer to readthedocs.org 2014-01-10 15:22:39 +01:00
Georg Brandl
d13c0470af Update requirements documentation. 2012-10-30 10:24:57 +01:00
Georg Brandl
53d06fda7b Closes #793: Fix docutils version references. 2011-11-01 09:16:37 +01:00
Georg Brandl
2c77c05473 Merge with 1.0 2011-09-23 22:03:34 +02:00
Georg Brandl
09b5e1736c Add reference to odt2sphinx. 2011-09-23 11:36:32 +02:00
Georg Brandl
07427c48fb Merge with 1.0. 2011-09-22 14:39:27 +02:00
Georg Brandl
3d4b8830a0 Fix #708: add reference to Pandoc. 2011-09-22 14:05:03 +02:00
Robert Lehmann
0dd3aa123d Closes #762: Update html2rest source location. 2011-09-16 08:25:00 +02:00
Daniel Neuhäuser
e46a8e9ded Change redirected URLs to the new locations 2011-02-05 21:48:54 +01:00
Daniel Neuhäuser
ed32972cbc http://jinja.pocoo.org/2/ -> http://jinja.pocoo.org/
This closes issue #607
2011-01-16 02:36:34 +01:00
Georg Brandl
d0900e8862 #465: update version requirement. 2010-07-10 16:50:32 +02:00
Daniel Neuhäuser
c3905938ea Use uuid as a requirement in the setup.py and mention it in the documentation for Python 2.4 2010-08-15 20:48:19 +02:00
Georg Brandl
c683c6ed83 Add some changes not picked up in the transplantation process. 2010-07-28 19:49:06 +02:00
Georg Brandl
c891fdfc60 Document new :py:func:.blah syntax. 2010-06-12 11:37:56 +02:00
Georg Brandl
09e6001e7a In the Python domain, references like `:func:.name``` now look for
matching names with any prefix if no direct match is found.
2010-06-12 10:41:56 +02:00
Georg Brandl
f5ede38405 #406: mention rst2pdf integration in intro. 2010-05-22 11:11:32 +02:00
Georg Brandl
a479d56b24 Move inline markup description to domains page. 2010-03-01 14:53:30 +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
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
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
0516082799 Add link to db2rst. 2009-08-04 22:39:17 +02:00
Georg Brandl
f3860b1af9 Update URL for html2rest. 2009-06-10 08:45:22 +02: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
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
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
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +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
d7dfb64c0e Allow build without conf.py using -C command line switch. 2008-11-16 13:29:10 +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
0b1f0d045a Converter is now fairly usable for non-Python core projects. 2008-09-24 15:50:37 +00:00
Georg Brandl
e8ba78c9d8 Add section on conversion from others. 2008-09-09 19:24:08 +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
5ed30072e3 Rename version to 0.3. 2008-05-04 17:57:11 +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
5fe73576a5 Support app.add_crossref_type(). 2008-03-28 18:45:32 +00:00
Georg Brandl
5a131c30a2 Don't install scripts twice. Thanks to lunar. 2008-03-23 17:43:22 +00:00
Georg Brandl
5d272bdd0d Make sphinx compatible with docutils SVN snapshots. 2008-03-23 15:07:15 +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
9f01c4c80a Add a para about sphinx <-> epydoc. 2008-03-18 07:39:40 +00:00
Georg Brandl
ca528099f6 Update documentation, add more content. 2008-03-16 11:19:26 +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