Commit Graph

20 Commits

Author SHA1 Message Date
Vladimir Kozhukalov 5500b2ae0b Remove unnecessary doc locales
Change-Id: Id2f101783973dd935b41403442f1f78533d7ac73
2023-10-18 20:52:08 -05:00
Vladimir Kozhukalov 7c2b754b4e Add pdf-docs tox env
Story: 2006104
Task: 35271
Change-Id: Ic06c61d1ed593cb27d99f0d5d2d179d81afabff0
2023-04-27 11:09:37 +03:00
Stephen Taylor 7ae7c06f86 [openstack-helm] Change whitelist_externals to allowlist_externals
Replace whitelist_externals with allowlist_externals in tox.ini

Change-Id: I0c90b92153b2781056f1590697edcc9b00a4bc0a
2022-12-13 18:34:52 +00:00
Brian Haley 7c2ad372f4 Fix 'tox -e releasenotes'
Running 'tox -e releasenotes' fails with:

ERROR: You must give at least one requirement to install

Added missing doc/requirements.txt dep to tox.ini

Trivialfix

Change-Id: I174460a0c1f4616cbdcb78bb8682adfe894f4206
2022-06-20 21:19:30 -04:00
Gage Hugo 6ea15a7f9d Add reno job to Openstack-Helm
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
2021-01-20 21:47:35 +00:00
wu.shiming aac748ebd2 Dep's should be restricted by tox-constraints
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
2020-11-17 16:21:34 +08:00
Andrii Ostapenko 44d263b2bf Enable templates linting
- 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>
2020-07-11 00:52:51 +00:00
Andrii Ostapenko 8cfa2aa390 Enable yamllint checks
- brackets
- braces
- colon
- commas
- comments
- document-end
- document-start
- empty-lines
- hyphens
- indentation
- new-line-at-end-of-file
- new-lines
- octal-values
- trailing-spaces

with corresponding code adjustment.

Also add yamllint.conf under the check.

Change-Id: Ie6251c9063c9c99ebe7c6db54c65d45d6ee7a1d4
2020-05-27 19:16:34 -05:00
Zuul 25475c90e9 Merge "Add yamllint tox environment" 2020-05-20 16:46:12 +00:00
Andrii Ostapenko ebfb2c6f72 Add yamllint tox environment
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
2020-05-19 19:26:47 +00:00
Tin Lam 8dbef0e39f chore(tox): update tox.ini
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>
2020-05-10 22:07:12 +00:00
Andreas Jaeger 34a7533b64 Cleanup py27 support and docs
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
2020-04-11 15:35:01 +02:00
jacky06 79f6f93a80 [ussuri][goal] Updates for python 2.7 drop
OpenStack is dropping the py2.7 support in ussuri cycle.

Only update required is in tox to define common baspython as py3 os that
all tox env including [testenv:functional] will use py3 instead of py2.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I7eb200a856b11673435143951898617ea52e63db
2020-04-06 10:10:29 +08:00
tonybrad c3d0a8db97 update the tox link to opendev
Change-Id: I352aca681a987286c49e0ffa6c4b6f1a1de10b9c
2019-04-30 16:49:50 +08:00
Andreas Jaeger 1d5dfa2468 Update docs building
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
2019-01-05 09:22:36 +00:00
Doug Hellmann 16df480a3c fix tox python3 overrides
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>
2018-10-01 06:46:25 +00:00
Tin Lam c90cf794da Update doc build to use py3
Per Stein community goal [0], update the doc build to use python 3 by default.

[0] https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I3992632a0768b4da0dedf2450e532d2724fc2e05
Signed-off-by: Tin Lam <tin@irrational.io>
2018-08-11 22:58:38 -05:00
Tin Lam e6991e1914 Update docs building infra
This patch set migrates some of the file structure in compliance with
the Project Testing Interface (PTI) [0] for doc build in OpenStack-Infra.
See [1] for more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I5995ffd3a6821fd629e00351728c27a045a7c076
Signed-off-by: Tin Lam <tin@irrational.io>
2017-12-29 00:07:26 -06:00
Gage Hugo 7b90c4017b Add upper constraints for testing
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
2017-05-16 13:34:42 -05:00
Michał Dulko e795466247 Beggining of docs conversion to OpenStack format
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
2017-04-27 17:04:17 +02:00