Add repo infra to build docs

Change-Id: I41c1f5db641bed9224739d7099a619e02119e461
This commit is contained in:
Adam Gandelman 2015-05-04 13:04:59 -07:00
parent c282bd2477
commit 09d0ae25af
19 changed files with 98 additions and 12 deletions

41
.gitignore vendored
View File

@ -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/*
*~
.*.swp
.coverage
cover
AUTHORS
ChangeLog
*.sqlite
*~

View File

View File

Before

Width:  |  Height:  |  Size: 233 KiB

After

Width:  |  Height:  |  Size: 233 KiB

View File

Before

Width:  |  Height:  |  Size: 233 KiB

After

Width:  |  Height:  |  Size: 233 KiB

View File

@ -26,6 +26,7 @@ Narrative Documentation
appliance.rst
contribute.rst
operation.rst
reference.rst
Licensing
---------

View File

@ -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

18
setup.cfg Normal file
View File

@ -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

22
setup.py Executable file
View File

@ -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)

1
test-requirements.txt Normal file
View File

@ -0,0 +1 @@
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3

23
tox.ini Normal file
View File

@ -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}