Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6635fbab5d4cf60be6bc317061cdac2118cebc25
* Remove doc/source/install/conf.py, it's not used
* Update openstackdocstheme version and remove settings that are now the
default.
* Use docs dependencies for api-ref building.
Change-Id: If37ed5bdbf6a1ef3107e66073eca9917704edee2
manila-status was missing in the list of man-pages. So when building the
man-pages with:
sphinx-build -b man doc/source doc/build/man
there is no "manila-status" in doc/build/man.
Change-Id: Ia2065af8d0ab51a0248d53b3474845ab429803d1
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.
Follow this rename.
Change-Id: I98d52f3b259cfffeb0e8ec996279ad4ff782276d
This commit adds a new tox target to build PDF documentation.
It's a community goal[0] to have PDF docs available.
Also some minor fixes are needed for PDF:
- Only show genindex and search for HTML. Theses elements do not make
sense within PDF documents
- Do not include full config sample files. This will not work and
produces a "Dimension too large" error during the latex run.
[0]
https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html
Change-Id: I66b8c47d599c97e66c2ca76faa66204d5e7c9c3b
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
This will show other versions of the doc, too.
Change-Id: I2f8e4fec3aa48b91d6ab636504ecc90553a4b802
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.
[1] https://review.openstack.org/532163
Change-Id: I11d4af5807a2f95dd6e6d06ae5c5f9a9ea45e2f9
This patch adds documentation and sample
file for default policy in code feature.
Change-Id: I597971a19ec61a1bf8c991b2712ec7644b2e2693
Partial-Implements: blueprint policy-in-code
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
use the recommended '%Y-%m-%d %H:%M' data time format.
Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.
Change-Id: I80972fec4c20bfaff82ebee56d84aac6aa65ac29
In accord with the OpenStack documentation migration spec [1],
this patch pulls over material from the centralized Configuration
Reference so that it will not be lost. As indicated in the spec,
dynamic generation of this material will be left for later work.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Closes-Bug: #1706181
Depends-On: Ib0fca0c16e14c05307bfc31ae50c65271b7402f1
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I7f3b584ac9907da1f07dedd26324cf4703bc7e6c
"python setup.py build_sphinx -b man" was failing after the new
directory layout introduced by https://review.openstack.org/491092.
Change-Id: I7aa904c0a3b043ce4c3aa25aba25486cec07d22a
Finish the transition to the openstackdocs theme in accord
with the OpenStack manuals project migration spec [1].
Also remove the already broken autodoc build since
it generates warnings (which we treat as errors) with
the new theme setup.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: Ieea33262101a1d2459492c1c8aaac5fe042279f6
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ifc80fc56648cef74c85464321d1850e8c68449a0
When build packages from sdist tarballs, git is not available. So
allow building the documentation without git.
Change-Id: I2e65c7eb6da2f87d97b8eae9fb7411de66416739
Our form of todo extension does not work with sphinx 1.5.2.
Remove it to unblock gate: we can add todos back in later with
more current methods. Also clean up some dangling cross-references
in the doc.
Co-Authored-By: Valeriy Ponomaryov <vponomaryov@mirantis.com>
Change-Id: If74b9e32ad2b5d8d70da60895d85588ff993797e
This file is not tested with our tox tests. However,
we'll fix it because we're responsible devs.
TrivialFix
Change-Id: I9aa8f422ad3e6360afdcff8ad83773f50ac5a727
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
