sloecode-dev team mailing list archive

["Guy K. Kloss" <guy.kloss@xxxxxxxxx>]

Hi,

I've just added a Sphinx skeleton structure for documentation to Sloecode. You 
can find it here:

lp:~guy.kloss/+junk/sloecode-sphinx

Feel free to merge!

You can edit the stuff under docs/source/ using ReST. Of course, for building 
it you need to have Sphinx installed. You can install that using "pip install 
sphinx" or using the Debian package `python-sphinx`.

The documentation as HTML is then build using setup.py with the `build_sphinx` 
target.

A couple other skeletal artifacts have found their way into the directory 
hierarchy for the Sphinx documentation. If not needed/wanted, just remove 
them, and adapt the ReST code.

Some further (minor) changes:

* setup.py is now enhanced with a little bit more meta-data, which can be
  quite useful if sloecode should find its way onto PyPI, but also otherwise.

* The version number is not hard coded in setup.py anymore, but extracted from
  the file VERSION, so it's easier to keep this information synchronised
  between setup.py, documentation, etc.

* Some files have been added to MANIFEST.in, which is essential if sloecode
  should be uploaded to PyPI, otherwise lots of it will be missing.

Hope I didn't forget anything or step onto somebody's toes.

Guy


-- 
Guy K. Kloss
School of Computing + Mathematical Sciences
Auckland University of Technology
Private Bag 92006, Auckland 1142
phone: +64 9 921 9999 ext. 5032
eMail: Guy.Kloss@xxxxxxxxx

Attachment: signature.asc
Description: This is a digitally signed message part.