Changes between Initial Version and Version 1 of Bitten Dev/Dev Docs

Timestamp:

May 7, 2010, 7:32:32 PM (14 years ago)

Author:

anatoly techtonik <techtonik@…>

Comment:

expand doc development a bit

Bitten Dev/Dev Docs

@@ +1 @@
+= Help Writing Bitten Documentation =
+
+Bitten distribution is accompanied by nice User Manual. You may see a poor reflection of it on [wiki:Documentation/index.html] pages. If you reading this then you already know that these pages are immutable, at least it is not possible to edit them from Wiki. It is because Trac is reading them directly from SVN using Include macros. Typical User Manual page source looks like this:
+{{{
+[[Title(Installation)]]
+[[Include(trunk/doc/install.txt)]]
+
+----
+See also: [wiki:Documentation]
+}}}
+
+These wiki pages were created manually and set to be read only by cmlenz some years ago.
+
+If you need to propose a change - you should be able to checkout docs from SVN, edit sources in reStructuredText format (similar to Wiki), rebuild them to see the result of your changes and send a patch to Bitten MailingList (or attach to a [/newticket new ticket]). This is all this pages are about.
+
+=== Checkout ===
+
+Just checkout Bitten. [source:trunk trunk/] or any of [source:tags tags/]/[source:branches/] versions will be ok. For example:
+{{{
+svn checkout http://svn.edgewall.org/repos/bitten/trunk bitten-trunk
+}}}
+will download sources into ''bitten-trunk'' directory.
+
+=== Building Docs ===
+
+Prerequisites:
+ 1. `docutils` (usually installed by Trac development setup anyway)
+ 2. `epydoc`
+
+Build:
+ 4. Run: `python setup.py build_doc`
+ 5. Open `doc/index.html` in a browser to verify result