christian.staudt at kit.edu
Thu Jun 18 10:21:22 CEST 2015
It seems what we need is not a CMS but a way to automatically generate a site from the repository.
Pelican : generates static sites from text written in Markdown or reStructuredText
Sphinx : "a tool that makes it easy to create intelligent and beautiful documentation” - we already use it to generate the Python docs from docstrings in the code, which are formatted with reStructuredText
Possible workflow: write anything that contains code examples in Jupyter Notebooks -> run before release to test -> export notebooks to reStructuredText  -> combine with automatically generated documentation -> generate HTML
Most or all of that can be scripted.
On 17 Jun 2015, at 15:49, Christian Staudt <christian.staudt at kit.edu> wrote:
> Hi NetworKit developers,
> I’m a bit worried about our website. There’s almost always something that is out of date (e.g. https://networkit.iti.kit.edu/features/) and may put people off. How can we keep the effort low that goes into writing and updating online documentation, yet keep it up-to-date and helpful?
> Look at projects that have nice websites, like:
> I think a common pattern is that the project website is automatically generated from the repository and code base with Sphinx. I think we should move towards that. Also I wouldn't shed a tear for the current page design if it went away.
> Another nice thing would be to have every documentation page that contains code in a form that is runnable and testable. Maybe Jupyter Notebooks can help.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 495 bytes
Desc: Message signed with OpenPGP using GPGMail
More information about the NetworKit