Skip to content

ViktorVoloshko/python-docs-dist

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

python-docs-dist

We no longer provide pre-built PDFs of the documentation. To build a PDF archive, follow the instructions in the Developer's Guide and run make dist-pdf in the Doc/ directory of a copy of the CPython repository.
Python documentation downloads page

Since building PDFs isn't as simple as building other formats, this project's aim is to spare you from inconvenience of doing it yourself as well as provide other formats of downloadable documentation and easy way to build it yourself using GitHub Actions.

Usage

If you just want the files, download desired version from Releases.

If you want to build them yourself:

  1. Fork this repository
  2. (Optional) Review and change options in .env
  3. Go to Actions and run Build workflow

Then, after successful build, grab artifacts from Actions. If you want them in Releases, create and push a tag that honors versioning model.

If your build fails, check Troubleshooting section.

Versioning

Tags and releases follow python_version.build versioning model where build is a build number. Builds are numbered sequentially, starting with 1.

Troubleshooting

Here are some known building caveats:

  • (PDF) Starting with version 3.15, building requires rsvg-convert tool to be available in system's PATH
  • In versions up to 3.12, Makefile lacks a step to ensure that dist directory exists before trying to store build artifacts there, which leads to an error if it wasn't created manually
  • Building version 3.10 requires imghdr module, which was removed in >=3.13

License

While the source code in this repository is original, all distributed artifacts are derived from the official CPython repository.

Component License
Source code GNU GPLv3
Distributed artifacts Python's license

About

Distributing downloadable Python documentation (and a way to build it using Actions)

Resources

License

Stars

Watchers

Forks

Contributors