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
============================
.. 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
Release history Release notifications | RSS feed
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.2.tar.gz
.
File metadata
- Download URL: ubuntudesign.documentation-builder-1.0.2.tar.gz
- Upload date:
- Size: 27.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9173b90cbde1afb07dc9a8fcf8e1bdbbdae0b99d0e0e6e09e06d3985148c4268 |
|
MD5 | 3eaa04b8da8d57af9c7a26111edd5064 |
|
BLAKE2b-256 | a2166a050d672ad9e6b11eef314357d20bb374292e670d0547d90e45fd53018e |