diff --git a/builddocs.sh b/builddocs.sh new file mode 100755 index 0000000..7fd0a16 --- /dev/null +++ b/builddocs.sh @@ -0,0 +1,4 @@ +#!/bin/sh + +sphinx-apidoc -f -o ./doc/source ./kollacli +python setup.py build_sphinx diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..6f60721 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/kollacli.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/kollacli.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/kollacli" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/kollacli" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/source/api/reference/hosts.rst b/doc/source/api/reference/hosts.rst deleted file mode 100644 index 20591b8..0000000 --- a/doc/source/api/reference/hosts.rst +++ /dev/null @@ -1,307 +0,0 @@ -*********************** -HOSTS API - Reference -*********************** - - -.. warning:: - - This hosts documentation is work in progress and may change in near future. - - -Hosts API -=============== - -.. _get_hosts_all: - -GET /v1/hosts -########################## -Retrieve all hosts in the inventory. - - -Request/Response: -************************************ - -.. code-block:: none - - Request: - - GET /v1/hosts - Headers: - X-Auth-Token: {token_id} - - Response: - - HTTP/1.1 200 OK - { - "hosts":[ - { - "hostname":{host_name1}, - "groups":[ - {group_name1}, - {group_name2}, - ..... - ], - }, - ..... - ] - } - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Successful request. | -+------+-----------------------------------------------------------------------------+ -| 401 | Missing or Invalid X-Auth-Token. Authentication required. | -+------+-----------------------------------------------------------------------------+ - -.. _get_host: - -GET /v1/hosts/{host_name} -########################## -Retrieve the host for the given host name. - - -Request/Response: -************************************ - -.. code-block:: none - - Request: - - GET /v1/hosts/{host_name} - Headers: - X-Auth-Token: {token_id} - - Response: - - HTTP/1.1 200 OK - { - "hostname":{host_name}, - "groups":[ - {group_name1}, - {group_name2}, - ], - ..... - } - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Successful request. | -+------+-----------------------------------------------------------------------------+ -| 401 | Missing or Invalid X-Auth-Token. Authentication required. | -+------+-----------------------------------------------------------------------------+ -| 404 | Host does not exist in inventory | -+------+-----------------------------------------------------------------------------+ - - -.. _post_host: - -POST /v1/hosts -########################## -Create new host. - -This call is used to create a new host and add it to the inventory. - -Request/Response (create or replace host): -************************************** - -.. code-block:: none - - Request: - - POST /v1/hosts/{host_name} - Headers: - Content-Type: application/json - X-Auth-Token: {token_id} - - { - "hostname":{host_name}, - "groups": [ - {group_name1}, - {group_name2}, - ..... - ], - } - - Response: - - HTTP/1.1 200 OK - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Successfully created host. | -+------+-----------------------------------------------------------------------------+ -| 400 | Bad Request. | -+------+-----------------------------------------------------------------------------+ -| 401 | Missing or Invalid X-Auth-Token. Authentication required. | -+------+-----------------------------------------------------------------------------+ -| 404 | Group does not exist in inventory | -+------+-----------------------------------------------------------------------------+ -| 409 | Host already exists in inventory | -+------+-----------------------------------------------------------------------------+ - - -.. _delete_host: - -DELETE /v1/hosts/{host_name} -############################## - -Delete host from the inventory. - -Request/Response: -***************** - -.. code-block:: none - - DELETE /v1/host/{host_name} - Headers: - X-Auth-Token: {token_id} - - Response: - HTTP/1.1 200 OK - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Successfully deleted host. | -+------+-----------------------------------------------------------------------------+ -| 401 | Missing or Invalid X-Auth-Token. Authentication required. | -+------+-----------------------------------------------------------------------------+ - -.. _check_host: - -POST /v1/hosts/{host_name}/actions -############################## - -Check verifies that the host has its ssh keys set up correctly (can be accessed without a -password from the deploy host). If the host check failed, the reason will be provided in -the response message. - -Request/Response: -***************** - -.. code-block:: none - - POST /v1/hosts/{host_name}/actions - Headers: - Content-Type: application/json - X-Auth-Token: {token_id} - { - "check": { - "host-name": {host_name}, - } - } - -Response: -********* - -.. code-block:: none - - 200 OK - - { - "message":{message_string} - } - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Host check was successful | -+------+-----------------------------------------------------------------------------+ -| 400 | Bad Request | -+------+-----------------------------------------------------------------------------+ -| 401 | Invalid X-Auth-Token or the token doesn't have permissions to this resource | -+------+-----------------------------------------------------------------------------+ -| 404 | Host does not exist in inventory | -+------+-----------------------------------------------------------------------------+ -| 405 | Host check failed | -+------+-----------------------------------------------------------------------------+ - -.. _setup_host: - -POST /v1/hosts/actions -############################## - -Host setup distributes the ssh keys into the appropriate directory/file on the host. -This assumes docker has been installed and is running on the host. Setup can be done -for a single host or multiple hosts. - -If a single host is to be setup, the host-name and host-password attributes must be -supplied. If multiple hosts are to be setup, the hosts-file-path must be -supplied. - -Either the host-name/password or hosts-file-path must be supplied. If both are supplied, -then all the hosts specified will be setup. - -If the host setup failed, the reason will be provided in -the response message. - -Request/Response: -***************** - -.. code-block:: none - - POST /v1/hosts/actions - Headers: - Content-Type: application/json - X-Auth-Token: {token_id} - - { - "setup": { - "host-name": {host_name}, - "host-password": {password}, - "hosts-file-path": {hosts_file_path} - } - } - -Response: -********* - -.. code-block:: none - - 200 OK - - { - "message":{message_string} - } - - -HTTP Status Codes -***************** - -+------+-----------------------------------------------------------------------------+ -| Code | Description | -+======+=============================================================================+ -| 200 | Host setup was successful | -+------+-----------------------------------------------------------------------------+ -| 400 | Bad Request | -+------+-----------------------------------------------------------------------------+ -| 401 | Invalid X-Auth-Token or the token doesn't have permissions to this resource | -+------+-----------------------------------------------------------------------------+ -| 404 | Host does not exist in inventory | -+------+-----------------------------------------------------------------------------+ -| 405 | Host setup failed | -+------+-----------------------------------------------------------------------------+ - diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..bfd46ac --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,262 @@ +# -*- coding: utf-8 -*- +# +# kollacli documentation build configuration file, created by +# sphinx-quickstart on Thu Mar 17 18:17:04 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'kollacli' +copyright = u'2016, Oracle' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'kollaclidoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'kollacli.tex', u'kollacli Documentation', + u'Oracle', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'kollacli', u'kollacli Documentation', + [u'Oracle'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'kollacli', u'kollacli Documentation', + u'Oracle', 'kollacli', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..3bb567e --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,20 @@ +.. kollacli documentation master file, created by + sphinx-quickstart on Thu Mar 17 18:17:04 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to kollacli's documentation! +==================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/setup.cfg b/setup.cfg index f710c90..62b7efa 100644 --- a/setup.cfg +++ b/setup.cfg @@ -71,3 +71,8 @@ input_file = openstack-kollacli/locale/openstack-kollacli.pot [compile_catalog] directory = openstack-kollacli/locale domain = openstack-kollacli + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/tox.ini b/tox.ini index 7bbcf50..0aae79b 100644 --- a/tox.ini +++ b/tox.ini @@ -32,8 +32,11 @@ commands = {posargs} [flake8] show-source = True -exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,ansible_plugins +exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,ansible_plugins [testenv:bandit] deps = -r{toxinidir}/test-requirements.txt commands = bandit -r kollacli + +[testenv:docs] +commands = ./builddocs.sh