Switch to openstackdocstheme 2.2.1 version. Using
this version 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: I611663fd224ddbd8a315732966c60ca67a5ffc40
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Use newer openstackdocstheme and Sphinx versions for Python3
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine
- Move python3 to testenv in tox.ini
- Switch to hacking 3, fix problems found.
Change-Id: I26fcab3b288b5ed64c74f7a6725b43036f195d44
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
Change-Id: Iac69ce000f71425acf476816024ed4bb94777780
Rather than use a fully custom theme for the TC site,
inherit from openstackdocstheme. This uses the new
display_global_toc_section and root_title options to
make it look closer to what we currently have, and
introduces a governance-specific sidebar TOC dropdown.
Change-Id: I160e31389fae571d45a35444c281507d8aef345e
Newer versions of Sphinx load the extensions before creating any of
the output directories, so the os.mkdir() call in the badge extension
was failing. Fix the problem by tying the badge step to the
build-finished event Sphinx emits when it reaches the end of its
build.
This change also uncaps Sphinx in the requirements file, since that
cap is not honored in the CI job anyway.
Change-Id: Ia6c232c5bc8c4015e00efe0b3b4182da2490acc7
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add the redirect instructions and add whereto as a step in the linters
build to ensure that all redirects are being tested.
Change-Id: Ib8ea0be2e063a7972f3a6ad71c32921512796136
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The new sphinx causes an issue with pbr. Cap the allowed range to
exclude the bad version.
Change-Id: Ia29abe93254e12443e4351d67e998908baf97086
Related-Bug: #1691129
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This reverts commit 5ddcdce53a.
According to wiredfool on the GitHub issue[1], this was an issue
with manylinux wheels as (non-)uploaded to PyPI and should be
fixed now. Let's see.
[1] https://github.com/python-pillow/Pillow/issues/2478
Change-Id: I6ca17860cd73feda5715589adc31f31c506edf31
Pillow 4.1.0 as released on April 4 is generating import
errors from the badge generation code:
ImportError: The _imagingft C module is not installed
This triggers test/gate failures on the docs job. Blacklist
this version to unblock governance while we figure out where
the issue exactly comes from.
Change-Id: I8ab8e00ddebfce8ed432405eec6a246352b41a47
Sphinx 1.5.0 and pbr 2.0 include a feature to let us pass the flag to
treat warnings as errors through setup.cfg. Update the version of Sphinx
we're using explicitly, and rely on an unbounded pbr specification to
give us the latest version on every run.
Also fix the one warning that caused the build to fail.
Change-Id: Ie93a3adf82b8f568a3cc4357c1e78da22ddc92c0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Turn on flake8 for code style checks, like in our other repos. Fix or
explicitly ignore various issues to allow the linter job to pass.
Change-Id: I7bfd8cf5e9c00dfa83c0393a4307fd54d2113047
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Rather than relying on oslosphinx to provide the theme, move the files
here. This allows us to make local customizations for the governance
site.
Change-Id: I43440a0528e6b2d91b8cdc6b3389448d51834dac
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
docutils 0.13.1 breaks our doc build in creative ways.
This was merged in requirements as [1].
[1] https://review.openstack.org/#/c/409529
Change-Id: I450e9cea26713e538739e86e4c9bae5f4c62bfe3
Adds a plugin for sphinx for generating badges for teams and
deliverables to use in READMEs, docs sites, etc. A badge corresponds
to a tag.
This plugin generates an `svg` image containing team tags and the
deliverable tags for each repo listed. Each tag corresponds to an SVG
image. All the tags are bundled in the same SVG image whose filename
corresponds to the repo name.
Each badge points to the tag link in the governance website.
This not handled yet:
- This doesn't handle "unofficial" projects, which would be nice to
have. If a project tries to access `project-team.svg` tag, instead of
returning 404, we could return a `project:unofficial` badge.
- Specialized colors for some tags. We might want to use different colors
for some groups. Team tags could be orange, etc.
- Group/Order tags generation by tag groups
Here's a dummy repo created as an example of how this work would be
consumed (or look like):
- https://github.com/flaper87/badges-tester
Change-Id: Ic70c17b60c0107e40b78bf21dc3a68c558eee06f
Currently most OpenStack code is linted, but YAML files are not.
This patch enables linting in tox tests using the yamllint tool [1].
It also corrects some indentation misalignments and a line longer
than 80 chars; the new CI test will prevent new errors from coming in.
[1]: http://yamllint.readthedocs.org/
Change-Id: Ie33e2636be97a09f27e519be185382be82fa19f2
Objectively communicates when project teams are driven by a single
organization, so that this fact can be taken into account in project
adoption decisions.
Change-Id: I399046ab7c3266b08c2a48382abfb89c33aab146
Render the YAML file contents as the list of official teams and create a
directive to render the list of projects with a given tag to avoid
having to update that data in two places.
Change-Id: I7c6effe6e440f2147f8c68df090152e716c38fba
This was added to work around bug 1091333. A new sphinx has been
released and so this is no longer necessary.
Change-Id: I9107884d964757a9154bdd1feb4ea6df4e9df43e
this brings over the pbr infrastructure for publishing rst files
to html with the oslo.sphix style. We'll need to move around
and reformat some of the documents for them to fully take effect
but this would be the first step in getting there.
Updated with our latest knowledge on how to do the right tox.ini
changes to handle sphinx issues.
This will then get used by another publish job to go to some
online repository.
Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
Jay Faulkner