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.1.tar.gz (24.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for ubuntudesign.documentation-builder-1.2.1.tar.gz
Algorithm Hash digest
SHA256 dc7545cdfe31acc41d097a8ac0ac739382202a23fc369b6e97069332fdc9fff9
MD5 8d9beeb933926603e4ce483a710fc055
BLAKE2b-256 d96e65316edc95be08752b3bfeba83dbb33eec8a0a0e9e623c0a1812b38a8da1

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