https://github.com/dataflake/dataflake.docbuilder
Sphinx and ReST documentation build system
https://github.com/dataflake/dataflake.docbuilder
documentation-tool python sphinx
Last synced: about 2 months ago
JSON representation
Sphinx and ReST documentation build system
- Host: GitHub
- URL: https://github.com/dataflake/dataflake.docbuilder
- Owner: dataflake
- License: other
- Created: 2017-05-27T09:06:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T08:21:16.000Z (about 1 year ago)
- Last Synced: 2025-04-24T00:49:22.003Z (about 2 months ago)
- Topics: documentation-tool, python, sphinx
- Language: Python
- Homepage: https://dataflakedocbuilder.readthedocs.io/
- Size: 268 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
.. 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