Edgewall Software

Version 1 (modified by anatoly techtonik <techtonik@…>, 14 years ago) (diff)

expand doc development a bit

Help Writing Bitten Documentation

Bitten distribution is accompanied by nice User Manual. You may see a poor reflection of it on 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 Mailing List (or attach to a new ticket). This is all this pages are about.

Checkout

Just checkout Bitten. trunk/​ or any of tags//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:

  1. Run: python setup.py build_doc
  2. Open doc/index.html in a browser to verify result