a821aeff00
This PS adds tooling and automation to automatically generate
Berth's documentation into feature-rich HTML pages that can
be hosted.
To run the documentation job, simply execute:
tox -e docs
Future docs should be written using the style described at
http://www.sphinx-doc.org/en/stable/markup/code.html and
located in berth/docs/source
This PS also adds basic building blocks required by most any
Python project:
* test-requirements.txt
* requirements.txt
* setup.cfg
* setup.py
* added more filters to .gitignore
Change-Id: I792b0244ce9909d70283730a29545304311c6dbc
31 lines
766 B
INI
31 lines
766 B
INI
[metadata]
|
|
name = Berth
|
|
summary = A deliberately minimalist VM runner for Kubernetes.
|
|
description-file = README.rst
|
|
|
|
author = Berth Authors
|
|
home-page = http://berth.readthedocs.io/en/latest/
|
|
classifier =
|
|
Intended Audience :: Information Technology
|
|
Intended Audience :: System Administrators
|
|
License :: OSI Approved :: Apache Software License
|
|
Operating System :: POSIX :: Linux
|
|
Programming Language :: Python
|
|
Programming Language :: Python :: 2
|
|
Programming Language :: Python :: 2.7
|
|
Programming Language :: Python :: 3
|
|
Programming Language :: Python :: 3.5
|
|
|
|
[files]
|
|
packages =
|
|
berth
|
|
|
|
[build_sphinx]
|
|
source-dir = docs/source
|
|
build-dir = docs/build
|
|
all_files = 1
|
|
warning-is-error = 1
|
|
|
|
[upload_sphinx]
|
|
upload-dir = doc/build/html
|