You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It great that the documentation is getting some love.
Out of curiosity, what is the rationale for a python/hosted approach rather than phpdoc or github's wiki (to name only two of many possible solutions)?
Github wiki isn't portable and is not included in a code release. I feel
human readable docs should be included in release downloads. People should
not have to rely on docs available only online.
Phpdoc is a great project for producing API documentation, but not high
level user documentation.
Sphinx is the only system I have seen that meets all these goals and that
is super easy to maintain and write. Its my favourite for this level of
documentation.
The documentation is a little unmanageable so it will be moved to a Sphinx setup hosted on readthedocs.
A new branch has been started for this work called sphinxdocs.
This project is already setup on Read the Docs and will begin working at idiorm.readthedocs.org when it is merged into the master branch.
The text was updated successfully, but these errors were encountered: