12 Commits

Author SHA1 Message Date
Joshua Harlow
2176f3f473 Move 'history' -> release notes section
This seems to better match what the other oslo
libraries are calling this section, so we might as
well call it that to.

Change-Id: I4a486d0ca61f81413ea398d5955b4027d66ce360
2015-09-25 08:21:05 -07:00
Joshua Harlow
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
Joshua Harlow
d04cf66a06 Add pypi download + version badges
Also makes the docs look more like the other
oslo libraries so that the content is easily readable
across projects.

Change-Id: I7b048bc4425197f87436281dd5e46619390c3f43
2015-04-07 21:09:17 +00:00
Sean Dague
df35680b67 add watchdog module
This provides the watchdog.watch function which is a contextmanager
that can be used before doing operations that have a high risk of
deadlocking or aberrantly taking huge amounts of time to complete
(which could be the root cause for other issues).

Unit tests require the use of sleep to make the timers pop either
before or after the event in question. There is 1 second buffer that's
encoded into each scenario which should be sufficient for unit tests
(even in busy systems). If that turns into an issue later, the buffer
can be increased (I was only seeing real skew of 1-2 ms locally).

Change-Id: I79e39f8a4aa702627ca39bea3e6fc672134b8a72
2015-01-09 15:38:48 -05:00
Doug Hellmann
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
Doug Hellmann
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
Dan Prince
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
Jenkins
34f5b81987 Merge "Add history file to documentation" 2014-09-23 04:03:07 +00:00
Davanum Srinivas
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
Doug Hellmann
394de2820d Add history file to documentation
Show the ChangeLog in the history page of the documentation.

Change-Id: I308b6eb1e729e78ae7c8c9e838d62587ac20cf66
2014-09-04 16:17:20 -04:00
Yuriy Taraday
37b90eda3e Fix docs generation
Also add docs environment to tox.ini to simplify local docs generation

Change-Id: Ie0444264e4e02d206ded2c7568d58a26cfec3ae2
2014-08-16 00:15:34 +04:00
Yuriy Taraday
6fc3e6808b exported from oslo-incubator by graduate.sh 2014-08-07 22:26:50 +04:00