openstack
/
fuel-devops
Code Issues Proposed changes

Fix docs build 

- fixed recursion error in templates.rst
- docs/source/modules added to .gitignore
- added setup.cfg to put html docs to right place
- docs renamed to doc (convention for openstack community)

Change-Id: I530228d0a764302ad7ca9d71be98856188c3fdcb
This commit is contained in:
Anton Studenov 2016-05-23 17:16:11 +03:00
parent cc2032fbca
commit 94c32c0a34
25 changed files with 51 additions and 399 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -48,7 +48,9 @@ coverage.xml
*.log *.log
# Sphinx documentation # Sphinx documentation
docs/_build/ doc/build/
# autogenerated doc sources
doc/source/modules/
# PyBuilder # PyBuilder
target/ target/

0
docs/Makefile → doc/Makefile
View File

0
docs/source/clsdiagram.rst → doc/source/clsdiagram.rst
View File

0
docs/source/commandline.rst → doc/source/commandline.rst
View File

34
docs/source/conf.py → doc/source/conf.py
View File

@ -13,24 +13,27 @@
# serve to show the default. # serve to show the default.
import os import os
import sys import glob
# 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('.'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('../../'))
from sphinx.apidoc import main as sphinx_apidoc_main from sphinx.apidoc import main as sphinx_apidoc_main
import shutil
shutil.rmtree('modules', ignore_errors=True)
# remove autogenerated rst files
for f in glob.glob('modules/*.rst'):
os.remove(f)
# generate docs
sphinx_apidoc_main([ sphinx_apidoc_main([
'', '',
'-o', # output dir
'modules', '-o', 'modules',
'../../devops' # source dir
'../../devops',
# exclude dirs
'../../devops/settings.py',
'../../devops/test_settings.py',
'../../devops/migrations/',
'../../devops/tests/',
'../../devops/templates/',
]) ])
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------
@ -81,8 +84,7 @@ release = '3.0.0'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = [ exclude_patterns = [
'**test**', # NOTE: use sphinx_apidoc_main to exclude source dirs
'**migration**',
] ]
# The reST default role (used for this markup: `text`) to use for # The reST default role (used for this markup: `text`) to use for

0
docs/source/getstart.rst → doc/source/getstart.rst
View File

0
docs/source/index.rst → doc/source/index.rst
View File

0
docs/source/install.rst → doc/source/install.rst
View File

0
docs/source/modules.rst → doc/source/modules.rst
View File

1
doc/source/modules/README.txt Normal file
View File

@ -0,0 +1 @@
This folder contains auto generated files. Please don't change them directly.

4
docs/source/templates/baremetal_example.yaml.rst → doc/source/template_examples/baremetal_example.yaml.rst
View File

@ -29,7 +29,9 @@ a baremetal lab (requires the [1] merged to fuel-qa).
[1] https://review.openstack.org/#/c/292977/ [1] https://review.openstack.org/#/c/292977/
.. code-block::yaml
.. code-block:: yaml
--- ---
aliases: aliases:

3
docs/source/templates/default_example.yaml.rst → doc/source/template_examples/default_example.yaml.rst
View File

@ -24,7 +24,8 @@ by most of fuel-qa system tests:
* STORAGE_POOL_NAME: Pool name for images of VMs * STORAGE_POOL_NAME: Pool name for images of VMs
* DRIVER_USE_HOST_CPU: CPU type used by VMs can be copied from the host * DRIVER_USE_HOST_CPU: CPU type used by VMs can be copied from the host
.. code-block::yaml .. code-block:: yaml
--- ---
aliases: aliases:

3
docs/source/templates/tagged_networks_example.yaml.rst → doc/source/template_examples/tagged_networks_example.yaml.rst
View File

@ -14,7 +14,8 @@ All slave nodes have only two network interfaces:
from this bridge, and getting untagged packets on the libvirt networks from this bridge, and getting untagged packets on the libvirt networks
'public', 'management', 'storage' and 'private'. 'public', 'management', 'storage' and 'private'.
.. code-block::yaml .. code-block:: yaml
--- ---
aliases: aliases:

32
docs/source/templates.rst → doc/source/templates.rst
View File

@ -1,15 +1,18 @@
.. _templates: .. _templates:
Templates
=========
YAML fuel-devops templates are used for creating virtual environments YAML fuel-devops templates are used for creating virtual environments
which describe which describe
Structure of the YAML template for environment creation Structure of the YAML template for environment creation
======================================================= =======================================================
YAML template for fuel-devops contains the following objects: YAML template for fuel-devops contains the following objects:
.. code-block::yaml .. code-block:: yaml
# In the 'template' can be stored all data related to the environment. # In the 'template' can be stored all data related to the environment.
# There are stored such keys like 'devops_settings' (for fuel-devops) # There are stored such keys like 'devops_settings' (for fuel-devops)
@ -59,9 +62,10 @@ YAML template for fuel-devops contains the following objects:
See detailed examples here: See detailed examples here:
.. toctree:: .. toctree::
:maxdepth: 2 :glob:
:maxdepth: 1
templates template_examples/*
=============================== ===============================
@ -84,13 +88,13 @@ Example 1:
I want to specify the name of a node from the environment variable: I want to specify the name of a node from the environment variable:
.. code-block::bash .. code-block:: bash
export MY_SLAVE09_NAME=contrail_slave_node-1 export MY_SLAVE09_NAME=contrail_slave_node-1
, and in the template, for node #9: , and in the template, for node #9:
.. code-block::yaml .. code-block:: yaml
- name: !os_env MY_SLAVE09_NAME - name: !os_env MY_SLAVE09_NAME
role: fuel_slave role: fuel_slave
@ -101,13 +105,13 @@ Example 2:
I want to override some names of keys in a dictionary, specifying, I want to override some names of keys in a dictionary, specifying,
for example, the name of the bond interface from environment variable: for example, the name of the bond interface from environment variable:
.. code-block::bash .. code-block:: bash
export MY_FIRST_BOND_IFACE=bond99 export MY_FIRST_BOND_IFACE=bond99
, and in the template, for necessary nodes: , and in the template, for necessary nodes:
.. code-block::yaml .. code-block:: yaml
network_config: network_config:
!os_env MY_FIRST_BOND_IFACE : !os_env MY_FIRST_BOND_IFACE :
@ -122,7 +126,7 @@ Example 3:
I want to specify the whole list of slave interfaces from environment I want to specify the whole list of slave interfaces from environment
variable: variable:
.. code-block::bash .. code-block:: bash
export MY_SLAVE_INTERFACES="\ export MY_SLAVE_INTERFACES="\
[\ [\
@ -135,7 +139,7 @@ variable:
, and in the template for required nodes: , and in the template for required nodes:
.. code-block::yaml .. code-block:: yaml
- name: slave-05 - name: slave-05
role: fuel-slave role: fuel-slave
@ -149,19 +153,19 @@ Example 4:
You can !include some parts of the yaml file from other yamls like You can !include some parts of the yaml file from other yamls like
interfaces_schema1.yaml, interfaces_schema2.yaml or interfaces_schema3.yaml: interfaces_schema1.yaml, interfaces_schema2.yaml or interfaces_schema3.yaml:
.. code-block::yaml .. code-block:: yaml
interfaces: !include interfaces_schema2.yaml interfaces: !include interfaces_schema2.yaml
, or specifying it with an environment variable: , or specifying it with an environment variable:
.. code-block::bash .. code-block:: bash
export LOAD_MY_INTERFACES='!include ./interfaces_schema2.yaml' export LOAD_MY_INTERFACES='!include ./interfaces_schema2.yaml'
, and use this variable in the template: , and use this variable in the template:
.. code-block::yaml .. code-block:: yaml
interfaces: !os_env LOAD_MY_INTERFACES interfaces: !os_env LOAD_MY_INTERFACES

22
docs/source/modules/devops.driver.dummy.rst
View File

@ -1,22 +0,0 @@
devops.driver.dummy package
===========================
Submodules
----------
devops.driver.dummy.dummy_driver module
---------------------------------------
.. automodule:: devops.driver.dummy.dummy_driver
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.driver.dummy
:members:
:undoc-members:
:show-inheritance:

22
docs/source/modules/devops.driver.ipmi.rst
View File

@ -1,22 +0,0 @@
devops.driver.ipmi package
==========================
Submodules
----------
devops.driver.ipmi.ipmi_driver module
-------------------------------------
.. automodule:: devops.driver.ipmi.ipmi_driver
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.driver.ipmi
:members:
:undoc-members:
:show-inheritance:

30
docs/source/modules/devops.driver.libvirt.rst
View File

@ -1,30 +0,0 @@
devops.driver.libvirt package
=============================
Submodules
----------
devops.driver.libvirt.libvirt_driver module
-------------------------------------------
.. automodule:: devops.driver.libvirt.libvirt_driver
:members:
:undoc-members:
:show-inheritance:
devops.driver.libvirt.libvirt_xml_builder module
------------------------------------------------
.. automodule:: devops.driver.libvirt.libvirt_xml_builder
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.driver.libvirt
:members:
:undoc-members:
:show-inheritance:

19
docs/source/modules/devops.driver.rst
View File

@ -1,19 +0,0 @@
devops.driver package
=====================
Subpackages
-----------
.. toctree::
devops.driver.dummy
devops.driver.ipmi
devops.driver.libvirt
Module contents
---------------
.. automodule:: devops.driver
:members:
:undoc-members:
:show-inheritance:

70
docs/source/modules/devops.helpers.rst
View File

@ -1,70 +0,0 @@
devops.helpers package
======================
Submodules
----------
devops.helpers.helpers module
-----------------------------
.. automodule:: devops.helpers.helpers
:members:
:undoc-members:
:show-inheritance:
devops.helpers.network module
-----------------------------
.. automodule:: devops.helpers.network
:members:
:undoc-members:
:show-inheritance:
devops.helpers.node_manager module
----------------------------------
.. automodule:: devops.helpers.node_manager
:members:
:undoc-members:
:show-inheritance:
devops.helpers.ntp module
-------------------------
.. automodule:: devops.helpers.ntp
:members:
:undoc-members:
:show-inheritance:
devops.helpers.retry module
---------------------------
.. automodule:: devops.helpers.retry
:members:
:undoc-members:
:show-inheritance:
devops.helpers.scancodes module
-------------------------------
.. automodule:: devops.helpers.scancodes
:members:
:undoc-members:
:show-inheritance:
devops.helpers.templates module
-------------------------------
.. automodule:: devops.helpers.templates
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.helpers
:members:
:undoc-members:
:show-inheritance:

30
docs/source/modules/devops.migrations.rst
View File

@ -1,30 +0,0 @@
devops.migrations package
=========================
Submodules
----------
devops.migrations.0001_initial module
-------------------------------------
.. automodule:: devops.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
devops.migrations.0002_add_field_created module
-----------------------------------------------
.. automodule:: devops.migrations.0002_add_field_created
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.migrations
:members:
:undoc-members:
:show-inheritance:

54
docs/source/modules/devops.models.rst
View File

@ -1,54 +0,0 @@
devops.models package
=====================
Submodules
----------
devops.models.base module
-------------------------
.. automodule:: devops.models.base
:members:
:undoc-members:
:show-inheritance:
devops.models.environment module
--------------------------------
.. automodule:: devops.models.environment
:members:
:undoc-members:
:show-inheritance:
devops.models.network module
----------------------------
.. automodule:: devops.models.network
:members:
:undoc-members:
:show-inheritance:
devops.models.node module
-------------------------
.. automodule:: devops.models.node
:members:
:undoc-members:
:show-inheritance:
devops.models.volume module
---------------------------
.. automodule:: devops.models.volume
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.models
:members:
:undoc-members:
:show-inheritance:

49
docs/source/modules/devops.rst
View File

@ -1,49 +0,0 @@
devops package
==============
Subpackages
-----------
.. toctree::
devops.driver
devops.helpers
devops.migrations
devops.models
devops.tests
Submodules
----------
devops.error module
-------------------
.. automodule:: devops.error
:members:
:undoc-members:
:show-inheritance:
devops.settings module
----------------------
.. automodule:: devops.settings
:members:
:undoc-members:
:show-inheritance:
devops.shell module
-------------------
.. automodule:: devops.shell
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops
:members:
:undoc-members:
:show-inheritance:

62
docs/source/modules/devops.tests.rst
View File

@ -1,62 +0,0 @@
devops.tests package
====================
Submodules
----------
devops.tests.factories module
-----------------------------
.. automodule:: devops.tests.factories
:members:
:undoc-members:
:show-inheritance:
devops.tests.test_helpers module
--------------------------------
.. automodule:: devops.tests.test_helpers
:members:
:undoc-members:
:show-inheritance:
devops.tests.test_manager module
--------------------------------
.. automodule:: devops.tests.test_manager
:members:
:undoc-members:
:show-inheritance:
devops.tests.test_scancodes module
----------------------------------
.. automodule:: devops.tests.test_scancodes
:members:
:undoc-members:
:show-inheritance:
devops.tests.test_shell module
------------------------------
.. automodule:: devops.tests.test_shell
:members:
:undoc-members:
:show-inheritance:
devops.tests.use_cases module
-----------------------------
.. automodule:: devops.tests.use_cases
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: devops.tests
:members:
:undoc-members:
:show-inheritance:

7
docs/source/modules/modules.rst
View File

@ -1,7 +0,0 @@
devops
======
.. toctree::
:maxdepth: 4
devops

4
setup.cfg Normal file
View File

@ -0,0 +1,4 @@
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source