3 ms·
Is it just me or the community is just filled with packages that have a single page, or nearly single page doc. Please don't do this. Documentation isn't an rf
by devxpy 8y ago
Is it just me or the community is just filled with packages that have a single page, or nearly single page doc.
Please don't do this. Documentation isn't an rfc. It's meant to be a _content first_ WEBSITE!
- plain html with little styling. Use the standard documentation themes if possible ( like read the docs )
- lots of cross references. Each class/func should be referenced back to it's API. (Sphinx is really good for this)