Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
23 lines (18 loc) · 791 Bytes

CONTRIBUTING.rst

File metadata and controls

23 lines (18 loc) · 791 Bytes
Raw

# How to release

  • Update CHANGELOG.rst
  • bump version (YYYY.MM) in pyproject.toml
  • commit
  • push to check one last time if the tests pass github side.
  • tag it (YYYY.MM).
  • build (python -m build)
  • Test it (in :file:`cpython/Doc` run ./venv/bin/pip install ../../python-docs-theme/dist/python-docs-theme-2021.8.tar.gz then build the doc using make html).
  • upload it: twine upload dist/*.
  • push the tag (git push --tags)

# Makefile usage

This project includes a simple Makefile for syncing changes to the theme with the main CPython repository. Run make help for details on available rules.

There is one configurable variable, CPYTHON_PATH, which should be the path to the CPython repository on your machine. By default, it points to ../cpython.