With OSH now publishing charts regularly with each change, there
needs to be a way to track these changes in order to track the
changes between chart versions.
This proposed change adds in a reno check job to publish notes
based from the changes to each chart by version as a way to
track and document all the changes that get made to OSH
and published to tarballs.o.o.
Change-Id: Iff8681c697957e4711754fc20b07fa6b728eb584
Tox trying to install latest versions for building docs which may
not be supported by stable and lower branches, so should be
restricted by respective version's tox-constraints.txt
Change-Id: I92b67aa48834c00ad175a311744c36542692f292
- braces
- brackets
- colons
- commas
- comments
- hyphens
- indentation
- key-duplicates
with corresponding code changes.
Also disable enforcement for document-(start|end) rules and
disables warnings to increase readability.
* Unrestrict octal values rule since benefits of file modes readability
exceed possible issues with yaml 1.2 adoption in future k8s versions.
These issues will be addressed when/if they occur.
Change-Id: Ic5e327cf40c4b09c90738baff56419a6cef132da
Signed-off-by: Andrii Ostapenko <andrii.ostapenko@att.com>
Adds yamllint tox environment with bootstrapping non-voting
configuration. To work around a situation that some of overrides
contain entries for replacement and are not actually valid yamls,
all directories are copied to temporary directory, */values*
files are modified to be readable by yamllint.
Change-Id: I0084b243c1df1692178c59fb5b1b2fb7a4cbac44
This updates to use TOX_CONSTRAINTS_FILE instead of
UPPER_CONSTRAINTS_FILE since the latter is obsolete.
Change-Id: I5be335d6aec053b58694610865513bf6c5488fb2
Signed-off-by: Tin Lam <tin@irrational.io>
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
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
Change-Id: I785318b3090d7117d74d165ba3236dc239cf9ea1
The repo used both openstackdocstheme and oslosphinx in requirements but
then configured openstackdocstheme, remove oslosphinx everywhere.
Instead of using sphinx-build, use docstheme-build-translated.sh to
build English and translated documents.
Update doc/source/conf.py for newer openstackdocstheme and require
a new enough version.
Remove module index - it does not exist, this is not a python repo where
autodoc works.
Remove sphinx-quickstart generated output from index.rst, it's not
needed anymore.
Change-Id: Ib3f09128226f0bcc78384b1ee2da811d62a5b59d
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: I5b07c573ea3594c011adc0ffbe629f0229e611f0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This change adds upper constraints for running tox in order
to both solve the issue with sphinx 1.6.1 and pbr breaking
the docs gate [0], as well as helping prevent this from
occuring in the future when a tool updates and ends up
causing issue with other required libraries.
This also adds an exclusion for 1.6.1 in test requirements
as posted here [1].
[0] https://bugs.launchpad.net/pbr/+bug/1691129
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-May/116821.html
Change-Id: I025e75fed186236be51c0fcfb7d35f694b0e42d8
This commit introduces initial infrastructure for building documentation
using the OpenStack's sphinx extension and tox. To demonstrate that
README.md is rewritten into README.rst and should appear in
documentation built by `tox -e docs`.
Partial-Implements: blueprint docs-to-rst
Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
