Metadata-Version: 1.0
Name: ubuntudesign.documentation-builder
Version: 0.3.7
Summary: 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.
Home-page: https://github.com/ubuntudesign/documentation-builder
Author: Canonical webteam
Author-email: robin+pypi@canonical.com
License: UNKNOWN
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
        ------------
        
        .. code:: 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:
        
        .. code:: 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:
        
        .. code:: 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: ./build)`
                --output-media-path {dirpath}     `# Where to put media files (default: ./build/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`
                --no-cleanup                      `# Don't clean up temporary directory after cloning repository`
                --ignore-file                     `# Filename of a markdown files to ignore and not parse into HTML. Can be declared multiple times. (default: README.md)`
        
Platform: UNKNOWN
