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

File details

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

File metadata

File hashes

Hashes for ubuntudesign.documentation-builder-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f99095b17ed0a3145c3955e71b03f7a2e336840cf77d5966339c8f4aa2bec908
MD5 e27d46207f86e77abddc0b3913b73abe
BLAKE2b-256 f5da4eac0d6a2d0095abfff7c18c5a7a339443b3d41bbb7ff994490e56e98829

See more details on using hashes here.

Supported by

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