From 09d0ae25af85653a51b204a876ea38025ffd5eb3 Mon Sep 17 00:00:00 2001 From: Adam Gandelman Date: Mon, 4 May 2015 13:04:59 -0700 Subject: [PATCH] Add repo infra to build docs Change-Id: I41c1f5db641bed9224739d7099a619e02119e461 --- .gitignore | 41 +++++++++++++----- {docs => doc}/.gitignore | 0 {docs => doc}/Makefile | 0 .../source/_static/neutron-akanda.png | Bin .../source/_static/neutron-canonical.png | Bin {docs => doc}/source/appliance.rst | 0 {docs => doc}/source/architecture.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/contribute.rst | 0 {docs => doc}/source/index.rst | 1 + {docs => doc}/source/operation.rst | 0 {docs => doc}/source/reference.rst | 4 +- {docs => doc}/source/rug.rst | 0 {docs => doc}/source/sample_boot.dot | 0 {docs => doc}/source/worker_diagram.dot | 0 setup.cfg | 18 ++++++++ setup.py | 22 ++++++++++ test-requirements.txt | 1 + tox.ini | 23 ++++++++++ 19 files changed, 98 insertions(+), 12 deletions(-) rename {docs => doc}/.gitignore (100%) rename {docs => doc}/Makefile (100%) rename {docs => doc}/source/_static/neutron-akanda.png (100%) rename {docs => doc}/source/_static/neutron-canonical.png (100%) rename {docs => doc}/source/appliance.rst (100%) rename {docs => doc}/source/architecture.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/contribute.rst (100%) rename {docs => doc}/source/index.rst (98%) rename {docs => doc}/source/operation.rst (100%) rename {docs => doc}/source/reference.rst (55%) rename {docs => doc}/source/rug.rst (100%) rename {docs => doc}/source/sample_boot.dot (100%) rename {docs => doc}/source/worker_diagram.dot (100%) create mode 100644 setup.cfg create mode 100755 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore index fbe2934..2452c74 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,35 @@ +# Compiled files +*.py[co] +*.a +*.o +*.so + +# Sphinx +_build +doc/source/api/ + +# Packages/installer info +*.eggs +*.egg +*.egg-info dist -.DS-Store -AUTHORS -ChangeLog build +eggs +parts +var +sdist +develop-eggs +.installed.cfg + +# Other +*.DS_Store +.testrepository .tox .venv -*.egg* -*.swp -*.swo -*.pyc -.testrepository -.idea/* -*~ \ No newline at end of file +.*.swp +.coverage +cover +AUTHORS +ChangeLog +*.sqlite +*~ diff --git a/docs/.gitignore b/doc/.gitignore similarity index 100% rename from docs/.gitignore rename to doc/.gitignore diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/source/_static/neutron-akanda.png b/doc/source/_static/neutron-akanda.png similarity index 100% rename from docs/source/_static/neutron-akanda.png rename to doc/source/_static/neutron-akanda.png diff --git a/docs/source/_static/neutron-canonical.png b/doc/source/_static/neutron-canonical.png similarity index 100% rename from docs/source/_static/neutron-canonical.png rename to doc/source/_static/neutron-canonical.png diff --git a/docs/source/appliance.rst b/doc/source/appliance.rst similarity index 100% rename from docs/source/appliance.rst rename to doc/source/appliance.rst diff --git a/docs/source/architecture.rst b/doc/source/architecture.rst similarity index 100% rename from docs/source/architecture.rst rename to doc/source/architecture.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/contribute.rst b/doc/source/contribute.rst similarity index 100% rename from docs/source/contribute.rst rename to doc/source/contribute.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 98% rename from docs/source/index.rst rename to doc/source/index.rst index bf5dc49..104fd68 100644 --- a/docs/source/index.rst +++ b/doc/source/index.rst @@ -26,6 +26,7 @@ Narrative Documentation appliance.rst contribute.rst operation.rst + reference.rst Licensing --------- diff --git a/docs/source/operation.rst b/doc/source/operation.rst similarity index 100% rename from docs/source/operation.rst rename to doc/source/operation.rst diff --git a/docs/source/reference.rst b/doc/source/reference.rst similarity index 55% rename from docs/source/reference.rst rename to doc/source/reference.rst index a26c311..0354fce 100644 --- a/docs/source/reference.rst +++ b/doc/source/reference.rst @@ -1,5 +1,5 @@ Configuration Options ===================== -:py:mod:`akanda-rug` uses :py:mod:`oslo.config` for configuration, so it's -configuration file format should be very familiar to OpenStack deployers:: +``akanda-rug`` uses ``oslo.config`` for configuration, so it's +configuration file format should be very familiar to OpenStack deployers diff --git a/docs/source/rug.rst b/doc/source/rug.rst similarity index 100% rename from docs/source/rug.rst rename to doc/source/rug.rst diff --git a/docs/source/sample_boot.dot b/doc/source/sample_boot.dot similarity index 100% rename from docs/source/sample_boot.dot rename to doc/source/sample_boot.dot diff --git a/docs/source/worker_diagram.dot b/doc/source/worker_diagram.dot similarity index 100% rename from docs/source/worker_diagram.dot rename to doc/source/worker_diagram.dot diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..4cb3e1f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,18 @@ +[metadata] +name = akanda +summary = Akanda +description-file = + README.md +author = Akanda +home-page = http://akanda.io + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..70c2b3f --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# 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. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..879156d --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..3a1e27c --- /dev/null +++ b/tox.ini @@ -0,0 +1,23 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = py27,pep8 + +[testenv] +usedevelop = True +install_command = pip install -U {opts} {packages} +setenv = VIRTUAL_ENV={envdir} + PYTHONDONTWRITEBYTECODE = 1 + LANGUAGE=en_US +deps = -r{toxinidir}/test-requirements.txt +whitelist_externals = bash + +[testenv:docs] +setenv = PYTHONHASHSEED=0 +sitepackages = False +commands = + python setup.py build_sphinx + +[testenv:venv] +setenv = PYTHONHASHSEED=0 +commands = {posargs}