3 ms·
For some reason, many Python libraries use readthedocs.io, their documentation is sparse, very shallow and the API reference is left undocumented, that I'm usua
by sph 4y ago
For some reason, many Python libraries use readthedocs.io, their documentation is sparse, very shallow and the API reference is left undocumented, that I'm usually displeased whenever I see that website and colour scheme. I know that I'm gonna be left wanting. Conversely, the Elixir documentation is so high quality that I'm put in a good mood whenever I land on their version of the documentation browser (generated by ExDoc).
It's not the fault of readthedocs per se, I guess it's what most projects that want a barebones documentation site and call it a day use.
- rmbyrro 4y agoI actually find too much aesthetics work rather distracting. It's commonly used to divert attention from what really matters... So, I appreciate Python bare bones documentation. Easier to judge its true value.
- autophagian 4y agoI thought readthedocs was just documentation hosting? If I remember correctly, the actual documentation generation is done with Sphinx.
- sph 4y agoI stand corrected, then my issues are with the incomplete Sphinx docs I often see shipping with Python libraries.