Search code examples
documentationgoogle-code

Best use of Google code wiki for project documentation


I've recently moved my project from sourceforge to Google code. I'm intrigued by the Google code wiki that is integrated with svn, but I'm not sure of the best way to use it to provide project documentation.

For my project, documentation could appear in three places: (1) on the wiki, (2) in the desktop application I'm developing (using wxPython), and (3) on the project website (which is http://www.openstv.org and is Drupal based).

I like the idea of using the Google code wiki as the primary source of the documentation, and then automatically incorporating this documentation in both the desktop application and on the project website .

Does anyone have any suggestions for doing this?


Solution

  • The Wiki files live in Subversion -- just svn checkout http://yourproject.googlecode.com/svn/wiki yourwiki and you get a yourwiki SVN repository that's easy to keep updated (just svn up in it once in a while, e.g. in a crontab).

    The format of the Wiki files is a Google variant of ReSTructured Text so you could write scripts to convert it to plain ReST and from there to whatever other formats you prefer for your other uses -- or, write ReST on your system, convert it to whatever you like (including perhaps Google's wiki format;-), and upload that...