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

Narrative documentation

Narrative documentation explaining how to use dataflake.docbuilder.

• Installation
  • Prerequisites
  • Install with pip
  • Install with zc.buildout
• Using dataflake.docbuilder
  • From pip
  • From zc.buildout
• Development
  • Bug tracker
  • Getting the source code
  • Preparing the development sandbox
  • Building the documentation
• Change log
  • 2.5 (2024-03-14)
  • 2.4 (2024-01-03)
  • 2.3 (2023-02-06)
  • 2.2 (2023-02-06)
  • 2.1 (2022-02-06)
  • 2.0 (2023-02-06)
  • 1.23 (2018-10-16)
  • 1.22 (2018-07-22)
  • 1.21 (2018-06-29)
  • 1.20 (2017-06-01)
  • 1.19 (2017-05-29)
  • 1.18 (2017-05-29)
  • 1.17 (2017-05-27)
  • 1.16 (2014-11-25)
  • 1.15 (2014-11-21)
  • 1.14 (2011-11-29)
  • 1.13 (2011-10-31)
  • 1.12 (2011-08-30)
  • 1.11 (2011-08-09)
  • 1.10 (2011-08-09)
  • 1.9 (2011-08-09)
  • 1.8 (2011-08-05)
  • 1.7 (2010-08-03)
  • 1.6 (2010-07-31)
  • 1.5 (2010-07-31)
  • 1.4 (2010-07-31)
  • 1.3 (2010-07-30)
  • 1.2 (2010-07-29)
  • 1.1 (2010-07-25)
  • 1.0 (2010-07-23)

Support

If you need commercial support for this software package, please visit https://www.zetwork.com.

Indices and tables

• Index

• Glossary