Move the 'untargeted' specs to the top of the page where they'll
be more easily found and create a 'previously approved specs'
section to organize the old specs better.
Change-Id: I4309c6193c8e5fcc2756685623acbe85577a779e
The openstack-tox-docs job runs with Sphinx 7.2.2,
and fails without openstackdocstheme fix 7e4e2b0.
Change-Id: Ie90a1a81ca00cda41dd0387f8c9798fad779c507
Change Ic038fd8b97e2 moved a spec to the 'zed' directory but
did not update the redirects to point to the new location.
Change-Id: Id082632888005f5e6aae2616e00bd7d73b8a0687
Add a redirect for change I067d113cacaf and fix some existing
redirects that were referring incorrectly to the .rst files
instead of the generated .html files.
Change-Id: I233af09553830f0f3c93d30cd313d498f2da4233
The team working on this effort has scaled it back to remove a
dependency that's been holding up development [0]. This change
has no impact on the current Cinder spec, which was approved
for Train, and whose approved status has been carried along through
Xena. It's now proposed for Yoga.
[0] https://review.opendev.org/c/openstack/glance-specs/+/792134
Change-Id: Ie483be9e82031d8c89dd49c8159373d769e5037d
Move unimplemented wallaby specs to xena and set up http redirects
so that the old URLs won't 404.
Change-Id: Ic7aa7e45ed9e6f09f72a87034cd0b88d1390117b
The current paths need '/openstack/cinder-specs' prepended to them.
(This was verified by fungi manually editing the deployed .htaccess
file on the specs website.)
Change-Id: I1a546d4b39c507336d3364f9d1c0129c04bec1f6
Make it clear that previously approved but unimplemented specs must
be re-proposed for the current release.
Change-Id: Ibe3da75827b340218ae1777615c5edb8dcec57f5
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.
Disable openstackdocs_auto_name to use 'project' variable as name.
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.
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: Iefbde88aa089a12a34fa1243c4d626127bb2bec6
New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.
Change-Id: I0d54db1b5967a226c5fc885aec4e170eee1dad6c
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine
- Fix problems found by sphinx-build
Change-Id: I258ba61fb3c2c5e83e71109dab941e304dde3f76
Move some specs that didn't get completed in Train but which are
being worked on for delivery in ussuri to the appropriate directory,
and set up redirects so that train URLs for the specs will redirect
to the current location.
Change-Id: Ic73f4801b8307ad2a0c9be0f3ab6c12b4019e0e7
OpenStack is dropping the py2.7 support in ussuri cycle.
specs repo has py2 specific requirement which is removed
or tox optimization.
Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html
Change-Id: I3792543bc58fa21c33c34cf09972a74b9a039208
The current sidebar lists all the links on the specs homepage.
This change makes it list only links created from headings on
the page so it can act as a navigation toolbar.
Change-Id: Ie1428e648207c6f07518548a1c3069577103c976
These are out-of-date (still have XML examples!), the v2 API is
deprecated and planned to be removed soon, and they've been
replaced by the v2 api-ref (which has not yet been removed).
Change-Id: I34f4e49f5ae4037277c136ee3e78d8eecee262cb
According to openstack/governance/projects.yaml, Cinder is the
OpenStack Block Storage service. This patch changes the specs
index page to reflect this.
Change-Id: I0db46fa65290974bb308f550506e3e6f6fc60c68
Partial-bug: #1841645
It was discussed at the Cinder Mid-Cycle that we
needed something to do with approved specs that were
still relevant but not being worked. The recommendation
was to add an untargeted folder like the one that Glance
uses. This patch does this.
I also discovered that the last two sections in
the index page were not displaying due to
incorrect RST format. This patch also fixes
that.
Change-Id: I3f909742501ab3a3f36ba9eee4ede0b814f76f2d
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
Change-Id: I722f8d5804b0daea33ee20d10a4eab903f57a6f7
This patch does two things to clean up gate package requirements,
adding a bindep file and moving packages to the right location.
Bindep controls which system packages are installed. If a project
does not have a bindep.txt file present, the gate jobs will fall
back to a common list of packages. These include things like
mariadb and various clients that are not needed for specs repos.
Added a basic bindep.txt file with just the things we need to
ensure are present for building the docs in specs.
There are also plans to stop looking at requirements.txt for specs
since these repos do not install Python code. The two locations
that are looked at are test-requirements.txt for running included
tests, and doc/requirements.txt for anything needed for doc builds
such as sphinx and plugins.
Change-Id: I3a222d7eec32b0d5ae6ef4ad20b34603931e13d6
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: Ib3228ad4d059f5fdb9b0ad4bf04956c3d81a1e31
Closes-Bug:#1693670
The focus for Ocata is bug fixes and stability with only
finishing features that were already in progress. So we need
to move some specs to pike folder.
Change-Id: I61425d6928fda714247f33abc5bed3b6e595e73b
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: Ic9043aab4466b115298d1c8bddc0f827177fdac9
Closes-Bug: #1529836
Jon Bernard