Back to Pixi

ReadTheDocs: Extend Build

examples/readthedocs-extend/README.md

0.67.21.2 KB
Original Source

ReadTheDocs: Extend Build

This example shows how to extend a ReadTheDocs sphinx build by customizing:

  • docs/.readthedocs.yaml to:
    • install native apt packages to support a heavyweight dependency
    • bootstrap a conda.environment with the supported mambaforge
    • prepare a pixi environment with build.jobs
    • avoid another file in the project root
      • this requires manual configuration in the ReadTheDocs web UI
  • docs/conf.py to:
    • support extended ReadTheDocs features provided by readthedocs-sphinx-ext
    • allow the default build to run against an un-published rtd.rst
    • use sphinx lifecycle events to run the actual build with pixi tasks

[!NOTE]

For a simpler mkdocs build, see the readthedocs-override example.