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: I859b38b139a37cb092b5d6c11998b7400613c342
This patch adds a new tox job/command for building the pdf version
of documentation.
tox -epdf-docs
In addition to adjusting the infra requirement for PDF build support,
the following changes are made to build a PDF doc.
- Inline sample config file is skipped for PDF doc
to avoid an LaTeX error "TeX capacity exceeded".
- Download link of sample config and policy files are disabled
for PDF doc as relative links do not make sense.
- "Search" and "genindex" page is only enabled for HTML doc
as they work only for HTML doc.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ib8ce96f4d043dcf0cfe6d3f8b64879f07bc5958c
Cleanup doc/requirements to just use what is needed for doc building.
Move reno to doc/requirements, add doc8 to test-requirements.
update tox.ini:
* doc8 should be in pep8 as linter and not docs according to PTI [1]
* Only build main doc in docs environment, CI uses this and we waste
just time building api-ref as well, there's a separate environment for
this. This follows PTI [1]
* Do not include requirements file for docs building, it's not needed
with apidoc.
* Use common deps for all docs build environments.
Cleanup doc/source/conf.py, with the switch to api-doc a lot of settings
are not needed anymore, also the eventlet bug is fixed.
Update openstackdocstheme to 1.20.0 and which allows to remove obsolete
setting of html_last_updated_fmt, project, latex_elements from conf.py.
Add doc8 to lower-constraints to make requirments-check happy.
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
Change-Id: If86dd619402495d9d4470b14cb270fcf53db6794
This adds the cinder-status CLI for performing upgrade checks as part of
the Stein cycle upgrade-checkers goal. It only includes a placeholder
for actual checks. Follow up patches will need to be added for anything
we identify as needing specific checking.
Story: 2003657
Task: 26123
Change-Id: I2e532d313d12e60848b17e869882e52ec456929b
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Since we have a CLI reference and specific doc subtree the
cinder-manage docs should live there. This moves the cinder-manage
page from man/ to cli/ and adds a redirect link.
Change-Id: If99416e8a382d2a6571412742276dccc591d180c
Cinder has always used a wiki page as the source of our
support matrix. Unfortunately the wiki gives us no way
to ensure that the information is accurate and makes it
harder to track changes. Moving to using the
sphinx-feature-classification library solves some of these
problems.
* It provides a programatic way to document driver support.
* It allows us to ensure that documentation is updated with
changes.
* It will provide a snapshot of the state of driver support
for a release at the time of release.
This matrix will serve as the truth for Cinder's driver support.
The existing wiki will be kept for historical purposes but I will
make a pointer to this new documentation and indicate that no
changes should be made to the wiki in the future.
Change-Id: I7c1b7fb539a48ec3b79e86c44ffe2d3005aeba25
This commit updates the author in the latex build metadata in the sphinx
conf.py. This was set to Anso Labs, LLC from the initial fork out of
Nova in 2012. It's highly unlikely that an LLC acquired by Rackspace in
2011 is actually the author of the latex version of the docs so this
commit changes it to be "Cinder Contributors" to be accurate.
Change-Id: I5f1f7ea2f389783fe8b936d67d0ab99d759c4124
In the past we had used an openstack-manuals tool to manually generate
config option tables that would then be included into driver config
documentation.
With the move of documentation in-tree and the deprecation and removal
of that tool, we have ended up with options that are no longer being
updated when drivers change, or maintainers are left manually updating
the existing tables.
This addes a sphinx extension to use a new config-table directive to
automatically pull in config options from the source so we no longer
need to perform any manual action to pick up changes.
Change-Id: I625fb96229001c326ed2400155e2d067279a400e
Remove some stale settings and get rid of setting version and
release. Those settings are now taken care of by openstackdocstheme
and do not need to be explicitly set, and since docs jobs no
longer install the project in order to generate docs, we are not
able to load those values from the python modules anyway.
Change-Id: I1a9a48538ca5c5e22e02f34c837e8fc783aeb2e9
Now that sphinxcontrib.apidoc is available, we should get rid of
the custom code we have for generating this information ourselves.
This also cleans up some really stale docs that are no longer
needed.
Change-Id: Iaa9fecc2478326b45b67a2cfd98de5f93f537efe
After giving some love to the multi-attach section it hopefully captures
the main characteristics of the functionality that we usually include
in the Admin Guide, such as volume creation, policies, microversions,
and back end support.
Depends-On: I11f97cf79e0c947b42de69cf8a7f6c1dbdb943a1
Co-Authored-By: Ildiko Vancsa <ildiko.vancsa@gmail.com>
Change-Id: I77bb849e039e1b44964ac0f30d48b5c16ca41b44
This patch adds documentation and sample
file for default policy in code feature.
Change-Id: I597971a29ec61a1bf8c991b2715ec7644b2e2692
Partial-Implements: blueprint policy-in-code
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: I37cff23175d111371bd7bcf3b53ff7e47ca80cb5
In the project, some of the terminology, like URL, URLs, API, APIs, OpenStack,
UUID, Cinder are neglectfully written as url, api, openstack, uuid, cinder.
This patch is to keep consistent of naming convention.
Change-Id: I98777fb4748cbc58b6e2fd1aca058d3e44069d07
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I24f83aa15cd4301aac9a7a941fe7d4c1e497c46e
Closes-Bug: #1659390
Signed-off-by: ashish.billore <ashish.billore@gmail.com>
Currently Sphinx will fail to generate the documentation if we are using
decorators from any OVO in cinder.objects, because the OVOs are only
added to the cinder.objects namespace when the CLI programs are run.
So we need to run `register_all` method during documentation generation
to avoid failures like:
AttributeError: 'module' object has no attribute 'Volume'
This patch modifies autogenerated doc/source/conf.py file and since now
it is no longer completely autogenerated it is added to PEP8 checks,
which required some minor changes.
Change-Id: Ifeeef61a778f9e3f3daceba8ed05cd2036219499
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.
This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.
Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
We had an extension for pulling out todo information from our docs. This
doesn't appear to have ever really been used though. Only a couple todo items
were published to the Cinder documentation, and the two published appear to
be extremely old.
Since this isn't really used and could just cause confusion, removing this
from the index page and removing the sphinx extension used to generate it.
Change-Id: I8993633538a5ee1687c4721bce3c520e8fb4ccfd
The oslo sphinxconfiggen module was added to the oslo.config
2.3.0 release. This enables config file generation as part of
the sphinx doc generation.
The generated config file will pick up the current config
options from the code base. And as an added bonus, it will
now be published to the docs.openstack.org site for easy
reference or download.
This also puts us inline with what other projects like Nova
are doing for sample config files and is the recommended
method from the Oslo team.
Change-Id: I912a97eb2686d3dc56e50d8641d7bd930179bc18
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: Ib289335198b0fe0a00922cbfe5c7fd7ff438ffcf
Closes-Bug: #1552251
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I4d0044c110c32f87ac0316a7e665e2bb9ea88813
Partial-Bug: #1529836
As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html
The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover" (dhellman).
Change-Id: I8427398e8d01c36f346e493a8144c1012ca7c5bf
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
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.
blueprint oslo.sphinx
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
Way back when Cinder was inagurated as a separate project, the docs
directory from Nova was used as a seed for the one in the Cinder repo
This patch is simply cleaning out images and files which have no
relation to Cinder at all, and are at best extremely outdated when
applied to Nova.
Aside from the deletions which are mainly images, and files related
to the configuration of CloudPipe, there is one modification to
conf.py which simply removes a reference to a vmware doc that no
longer exists.
Change-Id: I2140035f98bd332f25d7dd7569993bcd960a869e
Fix some pep8 issues in doc/ext/cinder_todo.py and
doc/source/conf.py and make the code looks pretty.
Change-Id: Ie164bc7328507e20b0ab5993ba97eaadbd74bf63
