Commit Graph

9 Commits

Author SHA1 Message Date
a04f5f10e1 switch from oslosphinx to openstackdocstheme
Change-Id: Ieadf9b992b269d54dd9c79523d5879b6ad71ba7c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-11 13:49:58 -04:00
7e47d32161 Add doc/ to pep8 check
We had unused imports there, this would prevent us from letting more of
such errors in.

Change-Id: Ie78c18dd3b9ab34370e47eba98b32740e0c83e1d
2016-05-12 14:05:20 +03:00
89f890b465 Remove unused import statement
We don't use fnmatch and fileinput, so
remove them.

Change-Id: Ic49f3a03f4ccafcd02c549a6bdb0a3175f9e07e1
2016-05-12 16:34:28 +08:00
933669ce29 add auto-generated docs for config options
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.

Change-Id: If7eb94b268bb82e0fcfbac9dfd231ea25ff53b24
2015-09-24 11:31:19 -07:00
d59543df4a Clean up API documentation
Use explicit files instead of auto-generating them.

Fail the build on a warning.

Tweak titles and other headings.

Add instructions for using lockutils-wrapper.

Change-Id: Ie92ce14b33180d35d84bbd0998e61b659487481d
2014-12-10 08:31:04 -05:00
bca4a0d827 Move out of the oslo namespace package
Move the public API out of oslo.concurrency to oslo_concurrency. Retain
the ability to import from the old namespace package for backwards
compatibility for this release cycle.

bp/drop-namespace-packages

Change-Id: I20d1647b1c3ef8cab3b69eccfe168eeb01703b72
2014-11-14 17:17:25 -05:00
fa52a63e4f Only modify autoindex.rst if it exists
This fixes doc build errors when using older Sphinx versions.

Change-Id: I0ed9bed311d6309257c0a111671d0fea46f5da7c
Closes-bug: #1387343
2014-10-29 20:32:51 -04:00
17b33061b2 Add code/api documentation
Once we use the pbr based build to generate files, we prune
the indexes to remove references to code we would like to
hide like the common modules and private modules in conf.py.
We reuse the same excluded_patterns variable that is already
used in Sphinx and filter these modules from autoindex.rst

Change-Id: I4baea1efa227ef14bc6706d59ff3dcad93c2eacc
Closes-Bug: #1364140
2014-09-04 22:48:57 -04:00
6fc3e6808b exported from oslo-incubator by graduate.sh 2014-08-07 22:26:50 +04:00