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
===
A tool for building a set of documentation files in HTML format,
from a remote git repository containing markdown files.
Installation
---
``` bash
pip3 install ubuntudesign.documentation-builder
```
Usage
---
The basic usage will build the markdown files from a remote repository in the standard format into the local directory:
``` bash
$ documentation-builder --source-repository git@github.com:juju/docs.git --media-destination media
```
There are many options for more advanced usage:
``` bash
$ documentation-builder \
--repository git@github.com:juju/docs.git `# Where to pull the markdown files from`
--branch new-version `# To pull from a different branch than the default`
--build-path build `# Where to place the built files`
--media-destination build/media `# Where to place the media files from the repository`
--template-path wrapper.tpl `# Path to an alternate wrapping template for the build HTML files`
--nav-path nav.html `# Path to an alternative navigation than the one provided in the repository`
--files-folder docs `# An alternative location inside the repository to look for markdown files (default: src)`
--media-folder media `# An alternative location inside the repository to look for media files (default: media)`
--relative-media-destination `# A URL base for linking to media inside the built HTML files (defaults to relative path to built media location - e.g.: ../media)`
--no-link-extensions `# Don't include '.html' extension in internal links`
===
A tool for building a set of documentation files in HTML format,
from a remote git repository containing markdown files.
Installation
---
``` bash
pip3 install ubuntudesign.documentation-builder
```
Usage
---
The basic usage will build the markdown files from a remote repository in the standard format into the local directory:
``` bash
$ documentation-builder --source-repository git@github.com:juju/docs.git --media-destination media
```
There are many options for more advanced usage:
``` bash
$ documentation-builder \
--repository git@github.com:juju/docs.git `# Where to pull the markdown files from`
--branch new-version `# To pull from a different branch than the default`
--build-path build `# Where to place the built files`
--media-destination build/media `# Where to place the media files from the repository`
--template-path wrapper.tpl `# Path to an alternate wrapping template for the build HTML files`
--nav-path nav.html `# Path to an alternative navigation than the one provided in the repository`
--files-folder docs `# An alternative location inside the repository to look for markdown files (default: src)`
--media-folder media `# An alternative location inside the repository to look for media files (default: media)`
--relative-media-destination `# A URL base for linking to media inside the built HTML files (defaults to relative path to built media location - e.g.: ../media)`
--no-link-extensions `# Don't include '.html' extension in internal links`
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-0.2.1.tar.gz.
File metadata
- Download URL: ubuntudesign.documentation-builder-0.2.1.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e4a4cf95b23f0516c832e71d9842eb6210aefa4251a165792fdc652f582a9668 |
|
| MD5 | a96597b78ed863c5f443c53bafc38e08 |
|
| BLAKE2b-256 | f713014160dbab3bbfdcc103f1a27448437e5f1003ababa78a94648ab09f0f8e |
