https://github.com/davidleoni/readthedocs-to-actions
Migrate from ReadTheDocs to Github Actions. Uses same Docker as RTD.
https://github.com/davidleoni/readthedocs-to-actions
Last synced: 2 months ago
JSON representation
Migrate from ReadTheDocs to Github Actions. Uses same Docker as RTD.
- Host: GitHub
- URL: https://github.com/davidleoni/readthedocs-to-actions
- Owner: DavidLeoni
- License: other
- Created: 2020-06-19T09:32:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-03T14:14:38.000Z (almost 3 years ago)
- Last Synced: 2025-03-16T12:03:46.495Z (3 months ago)
- Language: Shell
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://github.com/DavidLeoni/readthedocs-to-actions/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](https://github.com/ammaraskar/sphinx-action)
**DETAILS**: Tries to mimic RTD build process in [entrypoint.sh](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](https://github.com/DavidLeoni/jupman/blob/master/.github/workflows/main.yml)