Metadata-Version: 2.1
Name: dataflake.docbuilder
Version: 2.1
Summary: Automated Sphinx documentation builder
Home-page: https://github.com/dataflake/dataflake.docbuilder
Author: Jens Vagelpohl and contributors
Author-email: jens@dataflake.org
License: ZPL 2.1
Project-URL: Documentation, https://dataflakedocbuilder.readthedocs.io/
Project-URL: Sources, https://github.com/dataflake/dataflake.docbuilder
Project-URL: Issue Tracker, https://github.com/dataflake/dataflake.docbuilder/issues
Keywords: sphinx documentation
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
License-File: LICENSE.txt
Requires-Dist: setuptools
Requires-Dist: sphinx
Requires-Dist: zc.buildout
Requires-Dist: zc.recipe.egg
Provides-Extra: docs
Requires-Dist: pkginfo ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'

.. image:: https://github.com/dataflake/dataflake.docbuilder/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/dataflake/dataflake.docbuilder/actions/workflows/tests.yml
   :alt: Unit test status

.. image:: https://readthedocs.org/projects/dataflakedocbuilder/badge/?version=latest
   :target: https://dataflakedocbuilder.readthedocs.io
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/dataflake.docbuilder.svg
   :target: https://pypi.python.org/pypi/dataflake.docbuilder
   :alt: PyPI

.. image:: https://img.shields.io/pypi/pyversions/dataflake.docbuilder.svg
   :target: https://pypi.python.org/pypi/dataflake.docbuilder
   :alt: 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
