The biggest issue at the moment is the startling lack of documentation. The only "documentation" so far provided is in the form of minimalist docstrings. This travesty must be remedied before the v0.0.5 release.
All Hail the Sphinx
Sphinx is the de facto standard for Python documentation. The expectation is that there will be a doc directory containing the Sphinx configuration files and generated targets. The targets are not to be kept under version control.
Documentation Formats
Which documentation formats should be targeted? I think for now HTML should be the only output format by default. If the user wants other formats, they can enable them and generate the files for themselves.
Hosting
One solid option for hosting the documentation is the wiki.
The biggest issue at the moment is the startling lack of documentation. The only "documentation" so far provided is in the form of minimalist docstrings. This travesty must be remedied before the v0.0.5 release.
All Hail the Sphinx
Sphinx is the de facto standard for Python documentation. The expectation is that there will be a
docdirectory containing the Sphinx configuration files and generated targets. The targets are not to be kept under version control.Documentation Formats
Which documentation formats should be targeted? I think for now HTML should be the only output format by default. If the user wants other formats, they can enable them and generate the files for themselves.
Hosting
One solid option for hosting the documentation is the wiki.