We haven't used this in a long time and with the transition of docs from
a project to a SIG, it's not likely to be used again going forward.
Leave the .zuul.yaml file with noop-jobs to allow this patch to merge.
Change-Id: I557bace8008cc3b4fc1f78264f93291c49f897ad
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: Ie3ed990df99057896130ed0f7d5cf6c07db8c962
We use now "tox -e docs" and the sphinx-build invocation was using the
wrong directory - fix it.
Also, add doctrees option.
Change-Id: I527a08565cdc876dc862f1a944de06eddb7c33c9
Set basepython once in testenv and let the other environments inherit
the value.
Change-Id: I98aa7d500d2c3abe3f10b09b282ea550bec5f43c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.
Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.
Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.
See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html
Change-Id: I0a41a563276118d84c53078110593c54982c64b3
Story: #2002586
Task: #24293
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Change-Id: I7b65a9dbb394224550008f0feeb5a47bb743c208
Replace the old archiving spec, which was never implemented, with a
new one for queens describing the updated retention policy.
Change-Id: I6e6fa98c577aa0d95af0824b763ce6a3b4728cbe
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Some of the steps in the openstack-manuals repo are now being handled by
the templatization work, and don't need to be done by project teams as
they migrate their content.
Change-Id: I304b2dd6e8bb220425298cd5d442cc31e49cb699
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Currently the user-facing documentation belongs in the
openstack-manuals repo. Due to a severe decline in contributions,
the docs team has had to come up with a new way to move forward.
This spec proposes the new process for user-facing documentation
and how we are going to undertake the changes.
Co-Authored By: Doug Hellmann <doug@doughellmann.com>
Co-Authored By: Alexandra Settle <a.settle@outlook.com>
Change-Id: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
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: I4c14b2d1f5143171bb7a09fda1c09c0d576d1aa0
Closes-Bug:#1693670
Currently both oslosphinx and openstackdocstheme are in use
for content built to docs.openstack.org. To offer a better
user experience, update the logo, and consolidate efforts,
use one theme going forward.
Change-Id: Ib946c9215d85e472a55fd13ec246656614247019
yasfb 0.6.0 has been released and works with python2 and python3, so we
can remove the basepython setting from tox.ini.
Require at least version 0.6.1 since that fixes a unicode bug.
Change-Id: Ia52a874a58b693d090e6921e4a3a2ff49345d8ba
The number of approved OpenStack projects continues to grow while the
documentation team resources are shrinking. We need a new approach to maintain
the high quality of the OpenStack documentation set.
This specification proposes allowing project teams to manage their
administrator guide content similar to how the api-ref and installation guides
are being managed.
Change-Id: I70592f5c8a415dc1454a89f1012ad50178359953
Ensure pbr 2.0, which includes a number of bugfixes along with support
for Sphinx 1.5's 'warning-is-error' option is used. Then suppress
"WARNING: nonlocal image URI found" - which gets triggered by our
inclusion of badges in the README.
Change-Id: I1901ec7d19f4d13ef6c8b814243786fb23e70b78
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
Update and complete the documentation for openstack-doc-tools
and openstackdocstheme, and publish guides to
docs.openstack.org/developer.
Change-Id: I8437d28079a4da544cf6085704cccff7a7587f23
With pbr 2.0 and Sphinx 1.5, we need to use warning-is-error for sphinx
warnings.
Disable the non-local-uri warning, it's raised by our badge in
README.rst.
Change-Id: I77ff11a3cd0742bc4c1a6e7037644801877f6661
Sync with global requirements to use newer tools.
Remove docutils, we don't need the blacklisting of version 0.13.1
anymore.
Change-Id: I54786a6000427fda6ac93a6c254e2f646629ad20
Based on email thread and meeting conversation, adding a spec to
address the requirement to archive old content, and make it available
to users on older versions of OpenStack. Also adds Pike to specs index.
Change-Id: I7dffceddb040137b0f1448ba4baebcb5c5dfc9d9
blueprint: archiving
The 0.13.1 release breaks some documentation jobs
when it tries to build docs with remote images.
This has been reported upstream[0]. The version
matches the supported docutils versions for sphinx.
[0] https://sourceforge.net/p/docutils/bugs/301/
Change-Id: I7fb8c0fa9518b6b16eba6f7c5607c94136ebca53
The Sphinx 1.3 is not compatible with rst2pdf.
The another solution is using LaTeX to generate pdf files
So, update the content to generate pdf using LaTeX from
sphinx + rst2pdf
Change-Id: I773def424637157ae03e6ada51a905880c0e3bf1
Implements: blueprint build-pdf-from-rst-guides
Add links to keystone, nova, neutron, swift, and glance upgrade notes
in the Operations Guide
Change-Id: Ia09b6d6df15f25590e8205af876da960e72758ed
Implements: blueprint ops-guide-upgrades
Spec to continue work on the Architecture Design Guide
for Ocata
Implements: blueprint arch-guide-restructure-ocata
Change-Id: I411045798e4d3d056669a563af058d6217b7b6b2