9 Commits

Author SHA1 Message Date
Thomas Bechtold
903ae618bb Don't set html_last_updated_fmt without git
Using a timestamp as value for "html_last_updated_fmt" isn't good
for the reproducible builds initiative from different downstream
distributions because the build result always differs due to the
timestamp in the documentation.
Also when not setting "html_last_updated_fmt", the value can be set
via command line when running "sphinx-build -D".

Change-Id: Ic0c6dfc27a44d9b48e9a0c643f6301f596074c87
2016-04-13 08:46:31 +02:00
Davanum Srinivas
4e4caf67da Fallback if git is absent
When building packages if git is absent, then we should
fall back to a safe default.

Closes-Bug: #1552251
Change-Id: I9731416117de088282259846d49c2ec3ce09d1dc
2016-03-02 16:27:14 -05:00
ting.wang
5150661807 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since python 2.6.
Resolved with use of subprocess module.

Change-Id: Ifc456fa960c37bdfdf4b9635eb4b069b443b6a4b
Closes-Bug: #1529836
2016-01-15 13:57:01 +08:00
Doug Hellmann
0c65ef51c4 Add config options to the documentation
Add the directive to include the configuration options to the library
documentation.

Depends-On: I549c8db98bf548dd0a7e8869a57301fa4096f78c
(feature change in oslo.config)
Depends-On: I89e3e4fd41ed4c989c2dd4c9cd1d7b7e806fa15a
(global requirements change to update oslo.config version)

Change-Id: Ibec7071027fc33374a73abc30f8f672380bae6ea
2015-08-25 17:53:05 +00:00
Doug Hellmann
0a8c5145d4 Add drivers to the documentation
Use stevedore.sphinxext to populate a new page listing all available
drivers.

Add docstrings to the driver classes, including references to more
extensive documentation if it is available.

Depends-on: I1a24f9326b4e54174d9dc0ae366315fe29c3ac1b
Depends-on: Ie715f98fe0d3cba8b2f4f6235e7c2b6f79be7ea0

Change-Id: Ief0aa05e6deba0126d63faf13497d0fe0539e08d
2015-06-03 11:40:57 +00:00
Andreas Jaeger
f57a4ab337 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This causes docs jobs to fail because we error out on warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-12 22:48:38 +02:00
Dirk Mueller
de6d92fb92 Switch over to oslosphinx
Having the sphinx theme in the same namespace package
as the production code has been causing issues with
devstack installations. The solution settled on was
to rename oslo.sphinx to oslosphinx because oslo.sphinx
is not a "production" library.

See the linked bug report for more background details.

Closes-Bug: #1277168
Change-Id: I220b8901cef36499e91b92719f1e8e5461a95e92
2014-02-14 10:09:13 +00:00
Mark McLoughlin
3e8c891d67 Use oslo.sphinx and remove local copy of doc theme
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.

blueprint oslo.sphinx

Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
2013-07-10 08:51:37 +01:00
Mark McLoughlin
b5c41bba00 Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00