db1532214e
- fixes https://github.com/shaarli/Shaarli/issues/1451 - tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports - tools/doc/sphinx: suppress myst.xref_missing warnings caused by https://github.com/executablebooks/MyST-Parser/issues/564 - dockerfile: use makefile/sphinx instead of mkdocs to build HTML documentation - dockerfile: add bash to the docs build container (make: bash: No such file or directory) - tools/doc/readthedocs: force use of python 3.11 (readthedocs ERROR: No matching distribution found for sphinx==7.1.0) - tools/doc/readthedocs: add all required configuration variables https://docs.readthedocs.io/en/latest/config-file/v2.html#build-os - tools/doc/readthedocs: override build commands to allow the source directory to be different from the conf.py directory (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands, https://github.com/readthedocs/readthedocs.org/issues/1543) - tools/doc/readthedocs: manually set output directory (readthedocs ERROR: No _readthedocs/html folder was created during this build.) - doc: replace all references to mkdocs with sphinx
24 lines
530 B
YAML
24 lines
530 B
YAML
# .readthedocs.yml
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Build documentation in the "docs/" directory with Sphinx
|
|
sphinx:
|
|
configuration: doc/conf.py
|
|
builder: html
|
|
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.11"
|
|
commands:
|
|
- pip install sphinx==7.1.0 furo==2023.7.26 myst-parser sphinx-design
|
|
- sphinx-build -b html -c doc/ doc/md/ _readthedocs/html/
|
|
|
|
python:
|
|
install:
|
|
- requirements: doc/requirements.txt
|