A library for building data documentation.
Project description
Horkos Doc
A command-line tool for generating HTML documentation from horkos
schemas
Install
pip3 install horkos-doc
Usage
> horkos-doc --help
usage: horkos-doc [-h] [--config CONFIG] [--author AUTHOR]
[--home-page HOME_PAGE] [--output OUTPUT]
[input]
positional arguments:
input A directory of schema files from which to build the
html documentation. This is not required if a value is
set within the given config file.
optional arguments:
-h, --help show this help message and exit
--config CONFIG, -c CONFIG
The path to a configuration file for horkos-doc. This
file can be used to override the built-in default for
command-line arguments. By default this is
`.horkos-doc`.
--author AUTHOR, -a AUTHOR
The author of the documentation. This is used to
create copyright statements within the generated
documentation.
--home-page HOME_PAGE, --hp HOME_PAGE
The name to use for the home page of the generated
documentation. By default this is "Horkos Doc".
--output OUTPUT, -o OUTPUT
The directory in which to store built html. By default
this is ./build
If all the schema files are in ./schemas
to build the docs run:
horkos-doc ./schemas
Configuration
All options available on the command-line can also be set in an optional
configuration file. By default this file is expected to be .horkos-doc
.
[default]
input = ./schemas
output = ./docs
author = Mr. Foobar
home_page = The Docs!
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
horkos-doc-0.0.10.tar.gz
(11.4 kB
view hashes)
Built Distribution
Close
Hashes for horkos_doc-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b9afd28a78bcd56bc5270f4cd8d2c0720396657cc4e732790fc5f9c8353c200 |
|
MD5 | ed729d05c710b7709e0ce33f022985da |
|
BLAKE2b-256 | dc6ee89c8ec8300ef056a6d74cacf05fd6172ac8cda89312ca3a16da017b3069 |