PySoy: Sphinx XML Pages
completed by: Matt Habel
mentors: Arc Riley
Sphinx, using its Django-based (Jinja) templates, currently generates styled HTML pages for PySoy documentation. These are not easily integrated.
Modify the Jinja templates used to generate PySoy docs to output just the content part of the page (HTML fragment), such that these XML fragments can be used by another template system to display them in another website. These fragments should be proper, legal XML documents which may require wrapping the entire fragment in a standard root element.
Use these templates to build docs in docs/build/xml
in addition
to the current docs/build/html
. If templates already exist which
do this, then this task can be simply to update our build system to generate
our docs pages to use them.
While working on this task you should join and remain in #PySoy on Freenode to get help, feedback, and guidance from mentors and other developers. Code updates which may affect your work are also announced here as they happen.
When you've done, commit your work and post the resulting changeset url to this task.