Skip to main content

A command-line tool for building documentation from repositories into HTML files. Initially based on https://github.com/juju/docs/blob/master/tools/mdbuild.py.

Project description

Ubuntu documentation builder
============================

.. image:: https://travis-ci.org/CanonicalLtd/documentation-builder.svg?branch=master
:alt: build status
:target: https://travis-ci.org/CanonicalLtd/documentation-builder

.. image:: https://coveralls.io/repos/github/CanonicalLtd/documentation-builder/badge.svg?branch=master
:alt: code coverage
:target: https://coveralls.io/github/CanonicalLtd/documentation-builder


A tool for building a set of documentation files in HTML format, from a
remote git repository containing markdown files.

Installation
------------

.. code:: bash

snap install documentation-builder

For more information see `the documentation <docs/en/>`__.

Tests
----

To run tests:

.. code:: bash

./setup.py test

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ubuntudesign.documentation-builder-1.2.2.tar.gz (24.5 kB view details)

Uploaded Source

File details

Details for the file ubuntudesign.documentation-builder-1.2.2.tar.gz.

File metadata

File hashes

Hashes for ubuntudesign.documentation-builder-1.2.2.tar.gz
Algorithm Hash digest
SHA256 599909e457ef5c28e6999463763a593169020538fdfe9dfa8d44585dc4ad02f6
MD5 d695d1ef58ae3383a32723e2a22838d1
BLAKE2b-256 32d7c145515a31fba72f486bbf01d982aed2a0dc6109530f999462e6985fc5e9

See more details on using hashes here.

Supported by

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