Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Fix .rst doc files, auto-generation script #525
Our documentation is produced by reading the set of .rst files in
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
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.