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.0.0.tar.gz.

File metadata

File hashes

Hashes for ubuntudesign.documentation-builder-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7efd5f340c90c6709af2b890f29298cb955e8d9226613ed19fb3543167ab6a82
MD5 3f5833a7f7f6a95d28b6fec2cd55e43d
BLAKE2b-256 ffadda4d768714bfdab83cc38e69df53b2439953250759bd8c3b8d2bc6a96a4d

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