Use external builders to generate different formats (build.commands)

• Use zundler to create the HTMLZip version

• Use SimplePDF to generate the PDF version

• Use regular sphinx-build -b epub to build ePUB version

Note

This documentation has the flyout menu integrated even when using build.commands. This is because the readthedocs-sphinx-ext extension was manually installed on purpose.

---

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

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3"
  commands:
    - mkdir --parents $READTHEDOCS_OUTPUT/htmlzip $READTHEDOCS_OUTPUT/pdf $READTHEDOCS_OUTPUT/epub
    - pip install -r requirements.txt
    # HTML
    - sphinx-build -b html docs/ $READTHEDOCS_OUTPUT/html
    # HTMLZip
    - sphinx-build -b zundler docs/ $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT
    - cd $READTHEDOCS_OUTPUT ; zip -r -j htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT
    # PDF
    - sphinx-build -M simplepdf docs/ $READTHEDOCS_OUTPUT/
    - mv $READTHEDOCS_OUTPUT/simplepdf/"Test Builds.pdf" $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf
    # EPUB
    - sphinx-build -b epub docs/ /tmp/epub
    - mv /tmp/epub/TestBuilds.epub $READTHEDOCS_OUTPUT/epub/$READTHEDOCS_PROJECT.epub

sphinx:
  configuration: docs/conf.py

python:
  install:
    - requirements: requirements.txt

---

requirements.txt used to build these docs.

sphinx-autorun
git+https://github.com/AdrianVollmer/Zundler@main#egg=Zundler
sphinx-simplepdf
sphinx-rtd-theme
sphinx<6

# Installed to have the flyout and extras
readthedocs-sphinx-ext

# Sphinx docs requirements
sphinxcontrib-websupport

---

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

# -*- coding: utf-8 -*-

# Default settings
project = 'Test Builds'
extensions = [
    # Read the Docs flyout and extras
    'readthedocs_ext.readthedocs',

    'sphinx_autorun',
    'sphinx_simplepdf',
]

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


# Include all your settings here
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

---

>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2023, 6, 8, 7, 48, 7, 216002)