|
| 1 | +# Read the Docs configuration file for Sphinx projects |
| 2 | +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
| 3 | + |
| 4 | +# Required |
| 5 | +version: 2 |
| 6 | + |
| 7 | +# Set the OS, Python version and other tools you might need |
| 8 | +build: |
| 9 | + os: ubuntu-22.04 |
| 10 | + tools: |
| 11 | + python: "3.12" |
| 12 | + # You can also specify other tool versions: |
| 13 | + # nodejs: "20" |
| 14 | + # rust: "1.70" |
| 15 | + # golang: "1.20" |
| 16 | + |
| 17 | +# Build documentation in the "docs/" directory with Sphinx |
| 18 | +sphinx: |
| 19 | + configuration: doc/source/conf.py |
| 20 | + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs |
| 21 | + # builder: "dirhtml" |
| 22 | + # Fail on all warnings to avoid broken references |
| 23 | + # fail_on_warning: true |
| 24 | + |
| 25 | +# Optionally build your docs in additional formats such as PDF and ePub |
| 26 | +# formats: |
| 27 | +# - pdf |
| 28 | +# - epub |
| 29 | + |
| 30 | +# Optional but recommended, declare the Python requirements required |
| 31 | +# to build your documentation |
| 32 | +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html |
| 33 | +python: |
| 34 | + install: |
| 35 | + - requirements: doc/requirements-docs.txt |
| 36 | + - requirements: test-requirements.txt |
| 37 | + |
| 38 | + |
| 39 | +# git clone --depth 1 https://github.com/kubernetes-client/python . |
| 40 | +# git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master |
| 41 | +# git checkout --force origin/master |
| 42 | +# git clean -d -f -f |
| 43 | +# python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH |
| 44 | +# python -m pip install --upgrade --no-cache-dir pip setuptools |
| 45 | +# python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 |
| 46 | + |
| 47 | +# cat doc/source/conf.py |
| 48 | +# python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html |
| 49 | +# python -m sphinx -T -E -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlzip |
| 50 | +# python -m sphinx -T -E -b latex -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/pdf |
| 51 | +# cat latexmkrc |
| 52 | +# latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=kubernetes -interaction=nonstopmode |
| 53 | +# python -m sphinx -T -E -b epub -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/epub |
0 commit comments