Build Sphinx Docs with Zundler builder
Check out the Sphinx documentation built with zundler
at: zundler.html.
See also
See https://github.com/sphinx-doc/sphinx/issues/10688#issuecomment-1243012875 for more information about the process used to build this documentation in one single HTML file.
Read the Docs .readthedocs.yaml
configuration file used to build this docs.
1version: 2
2
3build:
4 os: ubuntu-22.04
5 tools:
6 python: "3"
7 apt_packages:
8 - tree
9 - libmagic1 # python-magic
10 - graphviz # dot command
11 jobs:
12 pre_build:
13 - git clone --depth 1 https://github.com/sphinx-doc/sphinx
14 - mkdir -p docs/_static
15 - sphinx-build -b zundler sphinx/doc/ _build/zundler
16 - cp _build/zundler/index.html docs/_static/zundler.html
17
18sphinx:
19 configuration: docs/conf.py
20
21python:
22 install:
23 - requirements: requirements.txt
requirements.txt
used to build these docs.
1sphinx-autorun
2git+https://github.com/AdrianVollmer/Zundler@main#egg=Zundler
3
4# Sphinx docs requirements
5sphinxcontrib-websupport
Sphinx configuration file used to build this docs (see full file),
1# -*- coding: utf-8 -*-
2
3# Default settings
4project = 'Test Builds'
5extensions = [
6 'sphinx_autorun',
7]
8
9latex_engine = 'xelatex' # allow us to build Unicode chars
10
11
12# Include all your settings here
13html_theme = 'sphinx_rtd_theme'
14html_static_path = ['_static']
15
16
17
18
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 10, 18, 14, 40, 37, 795478)