Changes between Version 2 and Version 3 of Bitten Dev/Dev Docs
- Timestamp:
- May 8, 2010, 12:15:42 AM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Bitten Dev/Dev Docs
v2 v3 1 1 = Help Writing Bitten Documentation = 2 2 3 Bitten distribution is accompanied by nice User Manual. You may see a p oor 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:3 Bitten distribution is accompanied by nice User Manual. You may see a plain 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 repository using an `[[Include()]]` macro. Typical User Manual page source looks like this: 4 4 {{{ 5 5 [[Title(Installation)]] … … 10 10 }}} 11 11 12 These wiki pages were created manually and set to be read only by cmlenz some years ago.12 These wiki pages are created manually and set to read-only, updatable only by Bitten developers. 13 13 14 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.14 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 attach the patch to a [/newticket new ticket] (or open a discussion on Bitten MailingList). 15 15 16 16 === Checkout === 17 17 18 Just checkout Bitten. [source:trunk trunk/] or any of [source:tags tags/]/[source:branches/] versions will be ok. For example:18 Just checkout Bitten. Usually [source:trunk trunk/], but any recent [source:tags tags/] or [source:branches/] is usually also fine. For example: 19 19 {{{ 20 20 svn checkout http://svn.edgewall.org/repos/bitten/trunk bitten-trunk 21 21 }}} 22 will download sources into ''bitten-trunk'' directory.22 will download sources into a ''bitten-trunk'' directory. 23 23 24 24 === Building Docs === … … 36 36 Just edit *.txt files, which are in [http://docutils.sourceforge.net/rst.html reStructuredText] format and rerun `python setup.py build_doc` to get the edits into html. If you are ready, make a patch file: 37 37 {{{ 38 svn diff > documentation. patch.txt38 svn diff > documentation.diff 39 39 }}} 40 40