Init the cooperative command-line interface

This commit is contained in:
Luke Murphy
2020-04-03 14:32:16 +02:00
commit 90a3239ffe
27 changed files with 1204 additions and 0 deletions

12
docs/Makefile Normal file
View File

@ -0,0 +1,12 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

View File

View File

@ -0,0 +1,5 @@
*********
Changelog
*********
.. include:: ../../CHANGELOG.rst

View File

@ -0,0 +1,6 @@
.. _code-of-conduct:
Code of Conduct
***************
.. include:: ../../CODE_OF_CONDUCT.rst

8
docs/source/conf.py Normal file
View File

@ -0,0 +1,8 @@
author = 'decentral1se'
copyright = '2019, decentral1se'
html_static_path = ['_static']
html_theme = 'sphinx_rtd_theme'
master_doc = 'index'
project = 'autonomic'
templates_path = ['_templates']
extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints']

View File

@ -0,0 +1,5 @@
**********
Contribute
**********
.. include:: ../../CONTRIBUTING.rst

12
docs/source/index.rst Normal file
View File

@ -0,0 +1,12 @@
.. include:: ../../README.rst
:end-before: _documentation
.. toctree::
:maxdepth: 1
:hidden:
install
upgrade
contribute
changelog
code-of-conduct

11
docs/source/install.rst Normal file
View File

@ -0,0 +1,11 @@
************
Installation
************
.. code-block:: bash
$ pip install autonomic
.. note::
This tool only supports Python >= 3.6.

7
docs/source/upgrade.rst Normal file
View File

@ -0,0 +1,7 @@
*******
Upgrade
*******
.. code-block:: bash
$ pip install --upgrade autonomic