0cd5d45706
Sphinx can be leveraged to auto-generate docs into feature-rich HTML pages. Docstrings in modules and classes can be easily auto-injected into documentation to produce high-level documentation, yet with accompanying code blocks and necessary docstrings. This commit introduces the tox job for auto-generating docs, as well as the foundational logic and documentation pages (index, HACKING and glossary). While hacking rules are introduced in HACKING.rst, they are not added in this commit; that will be done in a follow-up patchset. Additional documentation will also be included in a series of future patchsets. Change-Id: Iacd0e4542ebf481d66ab19dd43014b8d5bcc9e3f
35 lines
847 B
INI
35 lines
847 B
INI
[metadata]
|
|
name = deckhand
|
|
summary = Secrets management persistence tool.
|
|
description-file = README.rst
|
|
|
|
author = deckhand team
|
|
home-page = http://deckhand-helm.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 =
|
|
deckhand
|
|
|
|
[entry_points]
|
|
oslo.config.opts =
|
|
deckhand.conf = deckhand.conf.opts:list_opts
|
|
|
|
[build_sphinx]
|
|
source-dir = doc/source
|
|
build-dir = doc/build
|
|
all_files = 1
|
|
warning-is-error = 1
|
|
|
|
[upload_sphinx]
|
|
upload-dir = doc/build/html
|