diff --git a/.gitignore b/.gitignore index 6a785d1..cb0e86b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ .DS_Store AUTHORS ChangeLog +doc/build +build diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..9ed8489 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/almanach.git diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..98133ee --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,81 @@ +# Copyright 2016 Internap. +# +# 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. + +import datetime +import os +import sys + +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.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.ifconfig", + "sphinx.ext.viewcode", +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'almanach' +copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year + +# 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 + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] +html_theme_path = [] +html_theme = 'default' + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +# intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..2ead5d3 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,18 @@ +.. + 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 the Almanach documentation! +====================================== + +Almanach stores the utilization of OpenStack resources (instances and volumes) for each tenant. diff --git a/test-requirements.txt b/test-requirements.txt index e305a31..4dfa662 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,4 +7,5 @@ nose-blockage==0.1.2 flexmock==0.9.4 mongomock==2.0.0 PyHamcrest==1.8.5 -flake8==2.5.4 \ No newline at end of file +sphinx>=1.2.1,!=1.3b1,<1.3 # BSD +flake8>=2.5.4,<2.6.0 # MIT diff --git a/tox.ini b/tox.ini index 07bfcf3..218d8e7 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py27,flake8 +envlist = py27,pep8 [testenv] deps = @@ -9,10 +9,16 @@ setenv = PYTHONPATH = {toxinidir} commands = nosetests --tests tests -[testenv:flake8] +[testenv:venv] +commands = {posargs} + +[testenv:pep8] deps = -r{toxinidir}/test-requirements.txt -commands = flake8 +commands = flake8 {posargs} + +[testenv:docs] +commands = python setup.py build_sphinx [flake8] show-source = True -max-line-length = 120 \ No newline at end of file +max-line-length = 120