Initial tripleo-docs repository

Just a barebones.
This commit is contained in:
Derek Higgins 2015-08-26 12:43:10 +01:00
commit 29658f5f37
8 changed files with 133 additions and 0 deletions

4
README.rst Normal file
View File

@ -0,0 +1,4 @@
TripleO Documentation
==================================
Here lies the documentation for all things TripleO

49
doc/source/conf.py Normal file
View File

@ -0,0 +1,49 @@
# -*- coding: utf-8 -*-
import os
import sys
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.autodoc',
'sphinx.ext.intersphinx',
'oslosphinx',
]
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'TripleO'
copyright = u'2013, OpenStack Foundation'
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# 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}

9
doc/source/index.rst Normal file
View File

@ -0,0 +1,9 @@
TripleO Documentation
=====================
Getting Started
---------------
.. toctree::
:maxdepth: 1
introduction

View File

@ -0,0 +1,7 @@
Introduction
============
TripleO is a program aimed at installing, upgrading and operating OpenStack
clouds using OpenStack's own cloud facilities as the foundations - building
on nova, neutron and heat to automate fleet management at datacentre scale
(and scaling down to as few as 2 machines).

30
setup.cfg Normal file
View File

@ -0,0 +1,30 @@
[metadata]
name = tripleo-docs
author = OpenStack
author-email = openstack-dev@lists.openstack.org
summary = Docs for TripleO
description-file =
README.rst
home-page = http://git.openstack.org/cgit/openstack/tripleo-docs
classifier =
Environment :: OpenStack
Intended Audience :: Developers
Intended Audience :: Information Technology
License :: OSI Approved :: Apache Software License
Operating System :: OS Independent
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[egg_info]
tag_build =
tag_date = 0
tag_svn_revision = 0
[wheel]
universal = 1
[pbr]
warnerrors = True

21
setup.py Normal file
View File

@ -0,0 +1,21 @@
#!/usr/bin/env python
#
# 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)

2
test-requirements.txt Normal file
View File

@ -0,0 +1,2 @@
oslosphinx
sphinx>=1.1.2,<1.2

11
tox.ini Normal file
View File

@ -0,0 +1,11 @@
[tox]
envlist = docs
[testenv]
usedevelop = True
install_command = pip install {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt
[testenv:docs]
commands = python setup.py build_sphinx