diff --git a/.gitignore b/.gitignore index c083308..f40434f 100644 --- a/.gitignore +++ b/.gitignore @@ -45,6 +45,7 @@ nosetests.xml coverage.xml *,cover .hypothesis/ +ChangeLog # Translations *.mo diff --git a/doc/source/_templates/sidebarlinks.html b/doc/source/_templates/sidebarlinks.html new file mode 100644 index 0000000..6ecd4dd --- /dev/null +++ b/doc/source/_templates/sidebarlinks.html @@ -0,0 +1,11 @@ +

Useful Links

+ + +{% if READTHEDOCS %} + +{% endif %} diff --git a/doc/source/_theme/layout.css b/doc/source/_theme/layout.css new file mode 100644 index 0000000..4de226a --- /dev/null +++ b/doc/source/_theme/layout.css @@ -0,0 +1,4 @@ +{% extends "basic/layout.html" %} +{% set css_files = css_files + ['_static/tweaks.css'] %} + +{% block relbar1 %}{% endblock relbar1 %} diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf new file mode 100644 index 0000000..99ba97b --- /dev/null +++ b/doc/source/_theme/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = nature +stylesheet = nature.css +pygments_style = tango diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst new file mode 100644 index 0000000..3837742 --- /dev/null +++ b/doc/source/architecture.rst @@ -0,0 +1,2 @@ +Architecture +============ diff --git a/doc/source/conf.py b/doc/source/conf.py index 7fba02e..90b736d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,25 +34,15 @@ import warnings # 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 = [ - os.path.abspath('../..'), - os.path.abspath('../../bin') - ] + sys.path +sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('./')) # -- General configuration --------------------------------------------------- # 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.coverage', - 'sphinx.ext.ifconfig', - 'sphinx.ext.graphviz', - 'oslosphinx', - 'stevedore.sphinxext', - 'oslo_config.sphinxext', - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'oslo_config.sphinxconfiggen', - ] +extensions = [] config_generator_config_file = [ ('../../etc/oslo-config-generator/glare.conf', @@ -155,9 +145,9 @@ man_pages = [] # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = ['_theme'] -# The name for this set of Sphinx documents. If None, it defaults to +# The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = 'Glare' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -235,10 +225,10 @@ htmlhelp_basename = 'glareedoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, # documentclass [howto/manual]). -latex_documents = [ - ('index', 'Glare.tex', u'Glare Documentation', - u'Glare Team', 'manual'), -] +#latex_documents = [ +# ('index', 'Glare.tex', u'Glare Documentation', +# u'Glare Team', 'manual'), +#] # The name of an image file (relative to this directory) to place at the top of # the title page. diff --git a/doc/source/developer/creating_custom_artifact_type.rst b/doc/source/developer/creating_custom_artifact_type.rst new file mode 100644 index 0000000..baaeeb6 --- /dev/null +++ b/doc/source/developer/creating_custom_artifact_type.rst @@ -0,0 +1,2 @@ +How to write an Artifact Type +============================= diff --git a/doc/source/developer/devstack.rst b/doc/source/developer/devstack.rst new file mode 100644 index 0000000..a5f19fe --- /dev/null +++ b/doc/source/developer/devstack.rst @@ -0,0 +1,4 @@ +Glare Devstack Installation +=========================== + +TBD \ No newline at end of file diff --git a/doc/source/developer/index.rst b/doc/source/developer/index.rst new file mode 100644 index 0000000..ea9a394 --- /dev/null +++ b/doc/source/developer/index.rst @@ -0,0 +1,10 @@ +Developer's Reference +===================== + +.. toctree:: + :maxdepth: 3 + + webapi/index + creating_custom_artifact_type + devstack + troubleshooting diff --git a/doc/source/developer/troubleshooting.rst b/doc/source/developer/troubleshooting.rst new file mode 100644 index 0000000..a0670d5 --- /dev/null +++ b/doc/source/developer/troubleshooting.rst @@ -0,0 +1,4 @@ +Troubleshooting And Debugging +============================= + +TBD diff --git a/doc/source/developer/webapi/index.rst b/doc/source/developer/webapi/index.rst new file mode 100644 index 0000000..55962b8 --- /dev/null +++ b/doc/source/developer/webapi/index.rst @@ -0,0 +1,7 @@ +REST API Specification +====================== + +.. toctree:: + :maxdepth: 2 + + v1 diff --git a/doc/source/developer/webapi/v1.rst b/doc/source/developer/webapi/v1.rst new file mode 100644 index 0000000..d5cbe99 --- /dev/null +++ b/doc/source/developer/webapi/v1.rst @@ -0,0 +1,5 @@ +V1 API +====== + +This API describes the ways of interacting with Glare service via HTTP protocol +using Representational State Transfer concept (ReST). \ No newline at end of file diff --git a/doc/source/guides/configuration_guide.rst b/doc/source/guides/configuration_guide.rst new file mode 100644 index 0000000..ddaacdc --- /dev/null +++ b/doc/source/guides/configuration_guide.rst @@ -0,0 +1,4 @@ +Glare Configuration Guide +========================= + +TBD diff --git a/doc/source/guides/dashboard_guide.rst b/doc/source/guides/dashboard_guide.rst new file mode 100644 index 0000000..42527c0 --- /dev/null +++ b/doc/source/guides/dashboard_guide.rst @@ -0,0 +1,4 @@ +Glare Dashboard Installation Guide +================================== + +TBD diff --git a/doc/source/guides/glareclient_guide.rst b/doc/source/guides/glareclient_guide.rst new file mode 100644 index 0000000..4351387 --- /dev/null +++ b/doc/source/guides/glareclient_guide.rst @@ -0,0 +1,4 @@ +Glare Client / CLI Guide +======================== + +TBD: CLI commands and operations diff --git a/doc/source/guides/hooks_guide.rst b/doc/source/guides/hooks_guide.rst new file mode 100644 index 0000000..ecf068a --- /dev/null +++ b/doc/source/guides/hooks_guide.rst @@ -0,0 +1,4 @@ +Custom Actions Hooks Guide +========================== + +TBD diff --git a/doc/source/guides/installation_guide.rst b/doc/source/guides/installation_guide.rst new file mode 100644 index 0000000..20a8e44 --- /dev/null +++ b/doc/source/guides/installation_guide.rst @@ -0,0 +1,4 @@ +Glare Installation Guide +======================== + +TBD diff --git a/doc/source/guides/upgrade_guide.rst b/doc/source/guides/upgrade_guide.rst new file mode 100644 index 0000000..235f849 --- /dev/null +++ b/doc/source/guides/upgrade_guide.rst @@ -0,0 +1,7 @@ +Glare Upgrade Guide +=================== + +Database Upgrade +---------------- + +TBD diff --git a/doc/source/index.rst b/doc/source/index.rst index ec31e0b..e6fbd75 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,18 +1,58 @@ -.. - Copyright 2010 OpenStack Foundation - All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - Welcome to Glare's documentation! ================================= + +Glare is the OpenStack artifact service. This project aims to provide +a mechanism to define tasks and workflows without writing code, manage +and execute them in the cloud environment. + +Overview +-------- + +.. toctree:: + :maxdepth: 1 + + overview + quickstart + architecture + Roadmap + main_features + +User guide +---------- + +**Installation** + +.. toctree:: + :maxdepth: 1 + + guides/installation_guide + guides/configuration_guide + guides/dashboard_guide + guides/upgrade_guide + guides/glareclient_guide + guides/hooks_guide + +**API** + +.. toctree:: + :maxdepth: 2 + + developer/webapi/index + + +Developer guide +--------------- + +.. toctree:: + :maxdepth: 2 + + developer/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/main_features.rst b/doc/source/main_features.rst new file mode 100644 index 0000000..6bde6b5 --- /dev/null +++ b/doc/source/main_features.rst @@ -0,0 +1,4 @@ +Glare Features +============== + +TBD \ No newline at end of file diff --git a/doc/source/overview.rst b/doc/source/overview.rst new file mode 100644 index 0000000..a160026 --- /dev/null +++ b/doc/source/overview.rst @@ -0,0 +1,17 @@ +Glare Overview +============== + +What is Glare? +-------------- + +TBD + +Main use cases +-------------- + +TBD + +Rationale +--------- + +TBD \ No newline at end of file diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst new file mode 100644 index 0000000..457a888 --- /dev/null +++ b/doc/source/quickstart.rst @@ -0,0 +1,4 @@ +Quick Start +=========== + +TBD diff --git a/tox.ini b/tox.ini index 21993d7..fc0b073 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = py34,py27,pep8 +envlist = py27,pep8,py34 skipsdist = True [testenv]