To allow for our developer reference to be consistent with
the rest of the openstack documentation, we need to import
and render this theme on our developer reference.
This gives users a consistent experience as they may
be acquainted with the rest of the OpenStack documentation
(Admin Guide, User Guide, API Guide etc.)
before perusing the Manila developer reference.
It also provides our devref the "log-a-bug" feature so
readers may bring any mis-information to our attention.
This patch is part of a series of commits to improve
in-tree documentation.
Change-Id: I0e4686a273c5bf45c1d57764cd4c312870b06d6e
Partially-implements: bp improve-manila-developer-docs
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I02a6bcb43c8283848fb3866bb52cc4c0f50f4c92
Closes-Bug: #1552251
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
os.popen() is deprecated since python 2.6. Resolved with use of
subprocess module.
Change-Id: I09f69b57b6dad10a5a6034b39d70f7ab3141bc2a
Closes-Bug: #1529836
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: I32714af4407a77dc532dcbd18d8fce89f3863c26
Fix some problems found during documentation build:
* Remove reference to obsolete files
* Fix warning about too short title underlining
* Include api reference in index page
* Include man page in index page
* We have no _static files, so don't set the config option for it
* Fix reference for tests.share
Change-Id: I798d1ab65184689d75c559de9bffdf5969b9f013
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 can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Closes-Bug: #1368910
A packaging review in Fedora found that we had a copy of jQuery code.
Apparently, other OpenStack projects applied a patch to remove this
code, but Manila forked Cinder code from before. The across-the-board
change in OpenStack missed Manila, because we weren't incubated yet.
This patch is almost an exact copy of Cinder patch, but not cherry-
picked because of additional changes, such as the move from oslo.sphinx
to oslosphinx.
Patch is verified to produce readable documentation.
Change-Id: Id0b57f89ae6b63b26b7f0c3fa9af5a529e92ac69
Swiftclient was in dependencies as artifact after port from cinder.
Removed as unnecessary requirement itself and related stuff.
Change-Id: I92fa249031e98a38aba721c0f3d1d7489abd562a