mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update the readme a bit.
This commit is contained in:
parent
5d5e4c9b03
commit
92ebdc13aa
18
README
18
README
@ -1,9 +1,5 @@
|
|||||||
py-rest-doc
|
doctools README
|
||||||
===========
|
===============
|
||||||
|
|
||||||
This sandbox project is about moving the official Python documentation
|
|
||||||
to reStructuredText.
|
|
||||||
|
|
||||||
|
|
||||||
What you need to know
|
What you need to know
|
||||||
---------------------
|
---------------------
|
||||||
@ -78,3 +74,13 @@ web application has a configuration file ``build-web/webconf.py``,
|
|||||||
where you can configure the server and port for the application as
|
where you can configure the server and port for the application as
|
||||||
well as different other settings specific to the web app.
|
well as different other settings specific to the web app.
|
||||||
|
|
||||||
|
|
||||||
|
Writing new documentation
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
The new "Documenting Python" document, contained in a converted documentation
|
||||||
|
tree, already lists most of the markup and features, both standard reST and
|
||||||
|
additional, that can be used in the source docs.
|
||||||
|
|
||||||
|
More reST docs are at http://docutils.sf.net/rst.html, tutorials can be found on
|
||||||
|
the web.
|
Loading…
Reference in New Issue
Block a user