3 ms·
ReadTheDocs [1] is by far the best platform to have documentation. The simple reason: Everything gets into an Elasticsearch server (sponsored by Rackspace) whic
by susi22 13y ago
ReadTheDocs [1] is by far the best platform to have documentation. The simple reason: Everything gets into an Elasticsearch server (sponsored by Rackspace) which means you get wonderful full text search (and faceting).
See:
http://read-the-docs.readthedocs.org/en/latest/search.html?q=great http://read-the-docs.readthedocs.org/en/latest/search.html?q...
[1] https://readthedocs.org/ https://readthedocs.org/
- rogerbinns 13y agoSadly they aren't useful if your documentation is more complex. For my project I do use Sphinx for the doc, but there is a prebuild stage where some of the API information is extracted from non-Python text files (C source). Another part runs the example code and captures it as RST. There are various other nuances like that. readthedocs can't build that (make docs would work on my tree). I've contacted them several times to ask for how to proceed and never get an answer. You can see my Sphinx doc not at readthedocs but at http://rogerbinns.github.io/apsw http://rogerbinns.github.io/apsw