Improving This Documentation

You can help improve this documentation! It is version-controlled in the repository on GitHub. The source text is stored there in the src/ subdirectory and is formatted using Python’s reStructuredText system.

You can propose quick edits directly through the GitHub website, if you have an account there — for instance, this link will take you directly to a web-based editor for this very webpage. In general, the file corresponding to each page in the GitHub browser has a little pencil icon in its top-right that lets you open it up for editing.

The more manual process is as follows:

  1. Fork the repository to your own GitHub user account.
  2. Clone that fork onto your computer.
  3. Check out a new branch deriving from master to do your work.
  4. Make and commit your changes.
  5. Submit a pull request to the main repository proposing your changes.

Happy editing!