Helping with Documentation#
Python is known for having well-written documentation. Maintaining the documentation’s accuracy and keeping a high level of quality takes a lot of effort. Community members, like you, help with writing, editing, and updating content, and these contributions are appreciated and welcomed.
This high-level Helping with Documentation section provides:
an overview of Python’s documentation
how to help with documentation issues
information on proofreading
guidance on contributing to this Developer’s Guide
The next chapter, Documenting Python, gives extensive, detailed information on how to write documentation and submit changes.
The Documenting Python section covers the details of how Python’s documentation works. It includes information about the markup language used, specific formats, and style recommendations. Looking at pre-existing documentation source files can be very helpful when getting started. How to build the documentation walks you through the steps to create a draft build which lets you see how your changes will look and validates that your new markup is correct.
If you would like to be more involved with documentation, consider subscribing to the firstname.lastname@example.org mailing list. The issue tracker sends new documentation issues to this mailing list, and, less frequently, the list receives some directly mailed bug reports. The email@example.com mailing list discusses the documentation toolchain, projects, and standards.
Helping with documentation issues#
If you look at documentation issues on the issue tracker, you will find various documentation problems that may need work. Issues vary from typos to unclear documentation and items lacking documentation.
If you see a documentation issue that you would like to tackle, you can:
check to see if there is a paperclip or octocat icon at the end of the issue’s title column. If there is, then someone has already created a pull request for the issue.
leave a comment on the issue saying you are going to try and create a pull request and roughly how long you think you will take to do so (this allows others to take on the issue if you happen to forget or lose interest).
submit a pull request for the issue.
By following the steps in the Quick Guide to Pull Requests, you will learn the workflow for documentation pull requests.
While an issue filed on the issue tracker means there is a known issue somewhere, that does not mean there are not other issues lurking about in the documentation. Proofreading a part of the documentation, such as a “How to” or OS specific document, can often uncover problems (e.g., documentation that needs updating for Python 3).
If you decide to proofread, read a section of the documentation from start to finish, filing issues in the issue tracker for each major type of problem you find. Simple typos don’t require issues of their own, but, instead, submit a pull request directly. It’s best to avoid filing a single issue for an entire section containing multiple problems; instead, file several issues so that it is easier to break the work up for multiple people and more efficient review.
Helping with the Developer’s Guide#
The Developer’s Guide (what you’re reading now) uses the same process as the main Python documentation, except for some small differences. The source lives in a separate repository and bug reports should be submitted to the devguide GitHub tracker.
Our devguide workflow uses continuous integration and deployment so changes to the devguide are normally published when the pull request is merged. Changes to CPython documentation follow the workflow of a CPython release and are published in the release.
Developer’s Guide workflow#
$ git clone https://github.com/<your_username>/devguide
For your PR to be accepted, you will also need to sign the contributor agreement.
To build the devguide, some additional dependencies are required (most
importantly, Sphinx), and the standard way to install dependencies in
Python projects is to create a virtualenv, and then install dependencies from
requirements.txt file. For your convenience, this is all automated for
you. To build the devguide on a Unix-like system use:
$ make html
in the checkout directory. On Windows use:
> .\make html
You will find the generated files in
_build/html or, if you use
make htmlview, the docs will be opened in a browser once the build
completes. Note that
make check runs automatically when you submit
a pull request. You may wish to run
make linkcheck to make sure that it runs without errors.