Freeode

Select structure and tools for generating website and documentation

Registered by Eike

The website is currently written in pure HTML; the few bits of documentation are OOO files.
Tere needs to be a better tool chain, probably Sphinx with additions from Numpy.
http://sphinx.pocoo.org/

Blueprint information

Status:
Started
Approver:
None
Priority:
Low
Drafter:
None
Direction:
Needs approval
Assignee:
None
Definition:
Review
Series goal:
None
Implementation:
Good progress
Milestone target:
milestone icon 0.4.1
Started by
Eike

Related branches

Sprints

Whiteboard

Documentation should be based on Sphinx and on Matplotlib's extensions.
http://sphinx.pocoo.org/
http://matplotlib.sourceforge.net/sampledoc/

Sphinx extension to support docstrings in Numpy format
http://pypi.python.org/pypi/numpydoc/0.2

Tutorial and the start of a language documentation exist now. Especially there is a highlighter for Siml.

Really writing the whole website with Sphinx is not worked out, but should be doable.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.