Release 2021.8

Author: JulienPalard

.github/workflows/tests.yml

@@ -1,3 +1,5 @@
+---
+
 name: Tests
 
 on:
@@ -23,7 +25,7 @@ jobs:
       - name: setup requirements
         run: |
           python -m pip install --upgrade pip
-          python -m pip install jinja2 markupsafe
+          python -m pip install jinja2 markupsafe zc.lockfile
       - name: build docs
         run: |
           python3 ./docsbuild-scripts/build_docs.py --quick --build-root ./build_root --www-root ./www --log-directory ./logs --group $(id -g) --skip-cache-invalidation --theme $(pwd) --language en --branch 3.9

CHANGELOG.rst

@@ -2,6 +2,19 @@
 Changelog
 =========
 
+`2021.8 <https://github.com/python/python-docs-theme/releases/tag/v2021.8>`_
+------------------------------------------------------------------------------
+
+- Add the copyright_url variable in the theme (#67)
+  Contributed by jablonskidev
+- Improve readability (#79)
+  Contributed by Olga Bulat
+- Remove #searchbox on mobile to fix a layout bug (#76)
+  Contributed by Olga Bulat
+- Fix the appearance of version/language selects (#74)
+  Contributed by Olga Bulat
+
+
 `2021.5 <https://github.com/python/python-docs-theme/releases/tag/v2021.5>`_
 ------------------------------------------------------------------------------
 
@@ -13,7 +26,7 @@ Changelog
    Contributed by Aaron Carlisle.
 - Test Github action to validate the theme against docsbuild scripts. (#69)
    Contributed by Julien Palard.
-- Add the copy button to pycon3 highlighted code blocks. (#64) 
+- Add the copy button to pycon3 highlighted code blocks. (#64)
    Contributed by Julien Palard.
 
 
@@ -22,7 +35,7 @@ Changelog
 
 - Updated the readme, to remind user to install the package in a virtual environment. (#41)
    Contributed by Mariatta.
-- Updated the package url, using the GitHub repository instead of docs.python.org (#49) 
+- Updated the package url, using the GitHub repository instead of docs.python.org (#49)
    Contributed by Pradyun Gedam.
 - Added license information to the footer of the doc (#36)
    Contributed by Todd.

CONTRIBUTING.rst

@@ -0,0 +1,15 @@
+# How to release
+
+- Update CHANGELOG.rst
+- bump version (YYYY.MM) in setup.py and python_docs_theme/theme.conf
+- 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/*``.
+- bump version (YYYY.MM.dev) in setup.py and python_docs_theme/theme.conf
+- Commit this last bump.
+- push and push the tag (``git push && git push --tags``)

python_docs_theme/theme.conf

@@ -1,6 +1,6 @@
 [theme]
 inherit = default
-stylesheet = pydoctheme.css?2021.5.dev
+stylesheet = pydoctheme.css?2021.8
 pygments_style = default
 
 [options]
@@ -24,7 +24,7 @@ headlinkcolor = #aaaaaa
 codebgcolor = #eeffcc
 codetextcolor = #333333
 
-issues_url = 
+issues_url =
 root_name = Python
 root_url = https://www.python.org/
 root_icon = py.svg

setup.py

@@ -13,7 +13,7 @@
     name='python-docs-theme',
     # Version is date based as year.month[.serial], where serial is used
     # if multiple releases are needed to address build failures.
-    version='2021.5.dev',
+    version='2021.8',
     description='The Sphinx theme for the CPython docs and related projects',
     long_description=long_description,
     author='PyPA',