Skip to main content

Automated Sphinx documentation builder

Project description

Unit test status Documentation Status PyPI Python versions

dataflake.docbuilder

This package provides a set of scripts to automate building Sphinx-based package documentation for packages hosted on a source code revision control server. At this point only Git repositories are supported.

  • check out the current development trunk and all tagged versions

  • build all Sphinx-based documentation in them, if it exists

  • stitch together the trunk and release versions in a single HTML file to provide a simple jump-off page for all package versions

  • rebuild the Sphinx documentation if there were any changes since the last build

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page