Skip to content

Commit 08d2e54

Browse files
committed
Align to OpenStack Build Standards.
Rearranged Sphinx. Put project under PBR control. Added tox file. Added .testr.conf file in anticipation of testr testing. Change-Id: I55180a6a3d224816c82999bf66156c7874786b17
1 parent fdca1fc commit 08d2e54

12 files changed

+131
-325
lines changed

Diff for: .gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
AUTHORS
2+
ChangeLog
3+
dist/
4+
python_ipmi.egg-info/
5+
.tox

Diff for: .testr.conf

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[DEFAULT]
2+
test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
3+
OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
4+
OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \
5+
${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION
6+
7+
test_id_option=--load-list $IDFILE
8+
test_list_option=--list

Diff for: MANIFEST.in

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include AUTHORS
2+
include ChangeLog
3+
exclude .gitignore
4+
exclude .gitreview
5+
6+
global-exclude *.pyc

Diff for: Makefile

-130
This file was deleted.

Diff for: conf.py renamed to doc/source/conf.py

+21-15
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,32 @@
33
# python-ipmi documentation build configuration file, created by
44
# sphinx-quickstart on Tue Jun 18 09:15:24 2013.
55
#
6-
# This file is execfile()d with the current directory set to its containing dir.
6+
# This file is execfile()d with the current directory set to
7+
# its containing dir.
78
#
89
# Note that not all possible configuration values are present in this
910
# autogenerated file.
1011
#
1112
# All configuration values have a default; values that are commented out
1213
# serve to show the default.
1314

14-
import sys, os
15+
import os
16+
import sys
1517

1618
# If extensions (or modules to document with autodoc) are in another directory,
1719
# add these directories to sys.path here. If the directory is relative to the
1820
# documentation root, use os.path.abspath to make it absolute, like shown here.
21+
sys.path.insert(0, os.path.abspath('../../'))
22+
sys.path.insert(0, os.path.abspath('../'))
1923
sys.path.insert(0, os.path.abspath('.'))
2024

21-
# -- General configuration -----------------------------------------------------
25+
# -- General configuration ---------------------------------------------------
2226

2327
# If your documentation needs a minimal Sphinx version, state it here.
2428
#needs_sphinx = '1.0'
2529

26-
# Add any Sphinx extension module names here, as strings. They can be extensions
27-
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
2832
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.pngmath']
2933

3034
# Add any paths that contain templates here, relative to this directory.
@@ -47,10 +51,11 @@
4751
# |version| and |release|, also used in various other places throughout the
4852
# built documents.
4953
#
50-
# The short X.Y version.
51-
version = '0.5'
54+
from ipmi.version import version_info
5255
# The full version, including alpha/beta/rc tags.
53-
release = '0.5'
56+
release = version_info.release_string()
57+
# The short X.Y version.
58+
version = version_info.version_string()
5459

5560
# The language for content autogenerated by Sphinx. Refer to documentation
5661
# for a list of supported languages.
@@ -66,7 +71,7 @@
6671
# directories to ignore when looking for source files.
6772
exclude_patterns = ['_build']
6873

69-
# The reST default role (used for this markup: `text`) to use for all documents.
74+
# The reST default role (used for this markup: `text`) to use for all documents
7075
#default_role = None
7176

7277
# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -87,7 +92,7 @@
8792
#modindex_common_prefix = []
8893

8994

90-
# -- Options for HTML output ---------------------------------------------------
95+
# -- Options for HTML output -------------------------------------------------
9196

9297
# The theme to use for HTML and HTML Help pages. See the documentation for
9398
# a list of builtin themes.
@@ -167,7 +172,7 @@
167172
htmlhelp_basename = 'python-ipmidoc'
168173

169174

170-
# -- Options for LaTeX output --------------------------------------------------
175+
# -- Options for LaTeX output -------------------------------------------------
171176

172177
# The paper size ('letter' or 'a4').
173178
#latex_paper_size = 'letter'
@@ -176,10 +181,11 @@
176181
#latex_font_size = '10pt'
177182

178183
# Grouping the document tree into LaTeX files. List of tuples
179-
# (source start file, target name, title, author, documentclass [howto/manual]).
184+
# (source start file, target name, title, author, documentclass [howto/manual])
180185
latex_documents = [
181-
('index', 'python-ipmi.tex', u'python-ipmi Documentation',
182-
u'Jarrod Johnson \\textless{}[email protected]\\textgreater{}', 'manual'),
186+
('index', 'python-ipmi.tex', u'python-ipmi Documentation',
187+
u'Jarrod Johnson \\textless{}[email protected]\\textgreater{}',
188+
'manual'),
183189
]
184190

185191
# The name of an image file (relative to this directory) to place at the top of
@@ -206,7 +212,7 @@
206212
#latex_domain_indices = True
207213

208214

209-
# -- Options for manual page output --------------------------------------------
215+
# -- Options for manual page output -------------------------------------------
210216

211217
# One entry per manual page. List of tuples
212218
# (source start file, name, description, authors, manual section).

Diff for: index.rst renamed to doc/source/index.rst

File renamed without changes.

0 commit comments

Comments
 (0)