Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation out of one massive readme file #81

Closed
treffynnon opened this issue Nov 28, 2012 · 3 comments
Closed

Move documentation out of one massive readme file #81

treffynnon opened this issue Nov 28, 2012 · 3 comments
Assignees
Milestone

Comments

@treffynnon
Copy link
Collaborator

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.

@ghost ghost assigned durhamhale Nov 28, 2012
@tag
Copy link
Contributor

tag commented Nov 28, 2012

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)?

@treffynnon
Copy link
Collaborator Author

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.

@treffynnon
Copy link
Collaborator Author

Work has begun in commit a444f71

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants