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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for ubuntudesign.documentation-builder-1.3.1.tar.gz
Algorithm Hash digest
SHA256 fac63d66325a61087019bb81b3de6d4281cbe85f58746134e205f44bc67f02bd
MD5 f38d4590563a2bb72d16c255f37ec3c3
BLAKE2b-256 6a058023c0c0ac62b4b4b6a72552b9951ec6c6b67ef1c2c50565e8a9271e3a3f

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