[MPL] document autogeneration
Since the MPL docs are autogenerated using ReST, I'd like to know how to make the documentation for my own numeric constants conform to the new format. Access to the ReST sources themselves (even if they're only on mywikinet), accompanied by the steps needed to configure Docutils, would be best. TIA! Cromwell Enage __________________________________________________ Do You Yahoo!? Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
Cromwell Enage writes:
Since the MPL docs are autogenerated using ReST, I'd like to know how to make the documentation for my own numeric constants conform to the new format. Access to the ReST sources themselves (even if they're only on mywikinet),
They are in the CVS now ("libs/mpl/doc/src").
accompanied by the steps needed to configure Docutils, would be best.
1. Get a patched Docutils snapshot from http://www.mywikinet.com/docutils-06-nov-04.zip. 2. Unzip, go inside "docutils-06-nov-04" directory and do "python setup.py install". 3. Go to "libs/mpl/doc/src/refmanual" and do the following: python refmanual.py python ..../docutils-06-nov-04/tools/htmlrefdoc.py -g -t refmanual.gen <your-docs-location>/refmanual.html The first command enumerates all .rst files in the directory, producing "refmanual.gen". The second one takes care of the actual HTML generation (which is going to take some time). 4. Copy "libs/mpl/doc/style.css" into "refmanual.html"'s directory ("<your-docs-location>"). 5. Enjoy freshly generated docs :). 6. To reflect changes in .rst sources, repeat step 3 as needed. -- Aleksey Gurtovoy MetaCommunications Engineering
participants (2)
-
Aleksey Gurtovoy -
Cromwell Enage