Skip to content
book-open

GitHub Action

Sphinx Docs build with ReadTheDocs Docker

v2.0 Latest version

Sphinx Docs build with ReadTheDocs Docker

book-open

Sphinx Docs build with ReadTheDocs Docker

Reproduces ReadTheDocs build in Github Actions (to some degree). Also useful for local build

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Sphinx Docs build with ReadTheDocs Docker

uses: DavidLeoni/readthedocs-to-actions@v2.0

Learn more about this action in DavidLeoni/readthedocs-to-actions

Choose a version

ReadTheDocs to Github Actions

Sphinx docs build using the same Docker and environment of ReadTheDocs server.

Might be suitable when you need to:

  • migrate from ReadTheDocs
  • build (possibly complex) PDFs and epubs using maintained RTD Dockerfile
  • support multiple versions and languages
  • have locally reproducible build

STATUS: it's my first Github Actions attempt so you will probably need to adapt it to your own needs, especially when it comes to multiple versions and languages. See issues

The approach is a bit heavyweight (RTD docker alone is at least 5 gigas), so you may well want to try other fine solutions for Sphinx

DETAILS: Tries to mimic RTD build process in entrypoint.sh using RTD Dockerfile Ubuntu configuration, and if used as Github Action, Sphinx _build output is made available in /github/workspace which is shared by steps in a Github Action job.

Dockerfile is also usable locally for your own builds.

For an example usage, see Jupman