2023-09-12 13:01:25 +00:00
|
|
|
# Read the Docs configuration file for MkDocs projects
|
|
|
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
|
|
|
|
|
|
# Required
|
|
|
|
|
version: 2
|
|
|
|
|
|
|
|
|
|
# Set the version of Python and other tools you might need
|
|
|
|
|
build:
|
|
|
|
|
os: ubuntu-22.04
|
|
|
|
|
tools:
|
|
|
|
|
python: "3.11"
|
2023-09-12 13:07:09 +00:00
|
|
|
#nodejs: 18
|
2023-09-24 01:10:18 +00:00
|
|
|
jobs:
|
2023-09-29 17:44:32 +00:00
|
|
|
post_checkout:
|
|
|
|
|
# Needed for some plugins/extensions to work
|
|
|
|
|
- git fetch --unshallow || true
|
2023-09-24 01:10:18 +00:00
|
|
|
post_build:
|
2023-09-30 17:41:23 +00:00
|
|
|
- |
|
|
|
|
|
mkdir $READTHEDOCS_OUTPUT/api
|
|
|
|
|
git rev-parse HEAD > $READTHEDOCS_OUTPUT/api/commit
|
|
|
|
|
- |
|
|
|
|
|
cp -rv markdown/.well-known $READTHEDOCS_OUTPUT/html/.well-known
|
|
|
|
|
cp $READTHEDOCS_OUTPUT/html/assets/images/favicon.png $READTHEDOCS_OUTPUT/favicon.ico
|
2023-09-24 01:21:13 +00:00
|
|
|
apt_packages:
|
|
|
|
|
- libcairo2-dev
|
|
|
|
|
- libfreetype6-dev
|
|
|
|
|
- libffi-dev
|
|
|
|
|
- libjpeg-dev
|
|
|
|
|
- libpng-dev
|
|
|
|
|
- libz-dev
|
|
|
|
|
- pngquant
|
2023-09-12 13:01:25 +00:00
|
|
|
|
|
|
|
|
mkdocs:
|
2023-09-24 16:12:35 +00:00
|
|
|
configuration: mkdocs.readthedocs.yml
|
2023-09-29 17:44:32 +00:00
|
|
|
fail_on_warning: false
|
2023-09-12 13:01:25 +00:00
|
|
|
|
|
|
|
|
# Optionally declare the Python requirements required to build your docs
|
|
|
|
|
python:
|
|
|
|
|
install:
|
|
|
|
|
- requirements: requirements.txt
|
