Build The Docs (BTD)

This is a proof-of-concept to provide a 'lightweight' multi-version documentation generator for users that:

• Rely on a git hosting service to handle users and access permissions.
• Need to generate/build documentation in different formats (HTML, PDF, EPUB...) and for multiple versions of a project, using Sphinx.
• Want to be able to generate/build the documentation and have the products optionally deployed to a hosting service automatically.

The most expected use case is:

• Project hosted on GitHub.
• Web site hosted on GitHub Pages.
• A GitHub Actions workflow to build the site after each push.

Possible schemes:

• Save doc sources in:
  • A subdir of master/development branches.
  • TODO: The root of a given branch.
• Deploy to, either the same or a different repository:
  • Branch master.
  • Branch gh-pages.
  • TODO: Subdir docs in branch master.

Usage

This project is available as a Python package (btd), along with the plumbing to use it as a GitHub Action. Find usage guidelines and examples at buildthedocs.github.io/btd.