Documentation

You can find documentation for most of our stable, released projects at:

docs.mousepawmedia.com

That copy is based off the 'stable' branches of our repositories, and corresponds with the latest releases.

The documentation for the current in-development copy (based off of the 'master' branches of our repositories) can be found on DevNet, at mousepawmedia.net/docs.

FAQs: Documentation

(Click a question to view the answer.)

Why can't I find the documentation for a particular project?

Only stable, released projects have documentation hosted on docs.mousepawmedia.com; you may be able to find the docs for the development version of the project at mousepawmedia.net/docs.

Some projects are still too early in the development process to have documentation. Just be patient - we WILL have docs soon!

Finally, Redstring has docs in another format. We'll be migrating it to the new format and publishing it to docs.mousepawmedia.com soon.

What software do you use to produce the documentation?

Our documentation is written in ReStructuredText and rendered with Sphinx. It is then automatically published to our servers by Jenkins. You can find more information about these and other tools on our Technology page.

I found an error/typo/omission! Can you/I fix it?

The documentation is tracked on the related project repository, and can be changed in the same way the code can. You're welcome to file a bug report, or even better, to fix it yourself! See our Developers page for more information on getting involved.

Can I download a copy of the documentation?

Absolutely! The easiest way is to check out the GitHub repository for the project in question. Then, you can build the documentation yourself, outputting it to HTML, PDF, or one of many other formats. Instructions can be found in each repository's 'BUILDING.md' file.