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 # Build markdown documentation from the current directory
# or
$ documentation-builder --repository git@github.com:juju/docs.git # Build documentation from remote repository
```
Optional arguments:
``` bash
$ documentation-builder \
--repository {repository-url} `# A source repository. If provided, all source paths will be relative to this repository root`
--branch {branch-name} `# Pull from an alternative branch to the default (only valid with --repository)`
--source-path {dirpath} `# Path to the folder containing markdown files (default: .)`
--source-media-dir {dirpath} `# Path to the folder containing media files (default: ./media)`
--source-context-file {filepath} `# A file containing the context object for building the templates (default: ./context.yaml)`
--output-path {dirpath} `# Destination path for the built HTML files (default: .)`
--output-media-dir {dirpath} `# Where to put media files (default: ./media)`
--template-path {filepath} `# Path to an alternate wrapping template for the built HTML files`
--media-url {prefix} `# Prefix for linking to media inside the built HTML files (default: 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 # Build markdown documentation from the current directory
# or
$ documentation-builder --repository git@github.com:juju/docs.git # Build documentation from remote repository
```
Optional arguments:
``` bash
$ documentation-builder \
--repository {repository-url} `# A source repository. If provided, all source paths will be relative to this repository root`
--branch {branch-name} `# Pull from an alternative branch to the default (only valid with --repository)`
--source-path {dirpath} `# Path to the folder containing markdown files (default: .)`
--source-media-dir {dirpath} `# Path to the folder containing media files (default: ./media)`
--source-context-file {filepath} `# A file containing the context object for building the templates (default: ./context.yaml)`
--output-path {dirpath} `# Destination path for the built HTML files (default: .)`
--output-media-dir {dirpath} `# Where to put media files (default: ./media)`
--template-path {filepath} `# Path to an alternate wrapping template for the built HTML files`
--media-url {prefix} `# Prefix for linking to media inside the built HTML files (default: 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.3.0.tar.gz.
File metadata
- Download URL: ubuntudesign.documentation-builder-0.3.0.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1622be5b5a5b0c04e21689b46c5e63457f1dd7d704ffe87008ebc0a59f638834 |
|
| MD5 | 10c6cb67899d827e9b128534a643a3e6 |
|
| BLAKE2b-256 | dee35dd0c8cd5fc2089350f389c44cdb9090dae27eb0bb3703ecb19a75ab9057 |
