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

Fix .rst doc files, auto-generation script #525

Merged
merged 4 commits into from Dec 11, 2014

Conversation

Projects
None yet
1 participant
@jabooth
Member

jabooth commented Dec 11, 2014

Our documentation is produced by reading the set of .rst files in docs/source/api - these files dictate which functions and classes are documented where, with what style, and how documentation is grouped into chapters.

Maintaining these rst files is a pain, so I've written a little script for generating them. To use it, ensure menpo is in your Python interpreter, then

cd docs
python generate_rst.py

Will regenerate the rst files from the Menpo source in the style we like. In general, this will need to be run in the future when we add, remove, rename or move any class or function in Menpo. Don't just blindly commit the results though - run it, and then update the relevant index.rst file in the package to ensure everything makes sense and run a build.

This PR includes updated .rst files based on the auto-generation with some hand crafted changes.

@jabooth jabooth added the in progress label Dec 11, 2014

only generate menpo docs if __name__ == '__main__'
So we can re-use this code for menpofit/menpodetect etc

jabooth added a commit that referenced this pull request Dec 11, 2014

Merge pull request #525 from jabooth/docfixes
Fix .rst doc files, auto-generation script

@jabooth jabooth merged commit 168ae5d into menpo:master Dec 11, 2014

2 checks passed

continuous-integration/appveyor AppVeyor build succeeded
Details
continuous-integration/travis-ci The Travis CI build passed
Details

@jabooth jabooth deleted the jabooth:docfixes branch Dec 11, 2014

@jabooth jabooth removed the in progress label Dec 11, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment