Code Monkey home page Code Monkey logo

readthedocs-to-actions's Introduction

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

readthedocs-to-actions's People

Contributors

davidleoni avatar

Watchers

 avatar

Forkers

alisonrclarke

readthedocs-to-actions's Issues

Failsafe on PDF or EPUB error

As long as HTML is generated we should be happy, if PDF or EPUB fail Action users can detect later files where not generated

master vs main

Might want to make a note in the documentation that master may not be a branch in the new repos. - It is still set as the default branch.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.