Sphinx multi-page HTMLZip

Use the same output from StandaloneHTMLBuilder to generate a zipped version of it. Expose the .zip file as downloadable content.

Read the Docs .readthedocs.yaml configuration file used to build this docs.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3"
  jobs:
    post_build:
      - mkdir --parents _readthedocs/htmlzip
      - cp --recursive _readthedocs/html _readthedocs/$READTHEDOCS_PROJECT
      - cd _readthedocs ; zip --recurse-path --symlinks htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT

sphinx:
  configuration: docs/conf.py

python:
  install:
    - requirements: requirements.txt

Sphinx configuration file used to build this docs (see full file),

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# -*- coding: utf-8 -*-

# Default settings
project = 'Test Builds'
extensions = [
    'sphinx_autorun',
]

latex_engine = 'xelatex'  # allow us to build Unicode chars


# Include all your settings here
html_theme = 'sphinx_rtd_theme'





>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2023, 1, 31, 13, 9, 56, 88654)