Commit Graph

35 Commits

Author SHA1 Message Date
Takashi Kajinami b485549efc Uncap bashate
The bashate tool has been very stable for a while and we rarely expect
changes which may break existing scripts.

This removes the current capping to avoid updating the upper limit when
when a new release is created in bashate.

Change-Id: Iae94811aebf58b491d6b2b2773db88ac50fdd737
2024-01-29 11:42:32 +09:00
Anand Bhat 230f5c434c Changed minversion in tox to 3.18.0
The patch bumps min version of tox to 3.18.0 python in order to
replace tox's whitelist_externals by allowlist_externals option:
https://github.com/tox-dev/tox/blob/master/docs/changelog.rst#v3180-2020-07-23

Change-Id: Id8bdda703afc39d352e3a53877318dc30d91a5f7
2021-05-12 17:01:05 +05:30
Lucas Alvares Gomes 69a66fb62b Fix docs job
Sphinx 4.0.0 added a new dependency [0] which is causing the job to fail
at the moment.

This patch fix the problem by adding UC to the docs jobs.

[0] https://www.sphinx-doc.org/en/master/changes.html (LaTeX: add
tex-gyre font dependency)

Change-Id: I28019331017405c06577ada88f8e9f6d9a2afc23
Signed-off-by: Lucas Alvares Gomes <lucasagomes@gmail.com>
2021-05-11 14:05:22 +01:00
Andreas Jaeger 53c2f6fe23 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete section from setup.cfg
- Use newer openstackdocstheme and Sphinx version for python 3
- Remove install_command from tox.ini, the default is fine
- Move basepython into testenv
- Update bashate version

Change-Id: I3d78b3787af2efce831d223dbcab6cf84c358028
2020-05-09 13:35:01 +02:00
Masayuki Igawa 12e5ddcc2d
Add PDF documentation build
This commit adds PDF documentation build target 'pdf-docs' that will
build PDF versions of our docs. As per the Train community goal:

 https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: Iecb0fe5b957af7dae66bea04dfbd9c2fb4f74a99
Story: #2006070
Task: #35456
2019-09-26 18:06:46 +09:00
Andreas Jaeger 8dd89e52d0 Update docs building
Switch to "modern" way of building docs using sphinx-build directly,
remove now unsed parts from setup.cfg.

Upgrade to openstackdocstheme 1.20 and remove obsolete variables from
conf.py.

Convert external links to internal RST links so that Sphinx can verify
that they are correct.

Replace redirected links with new targets.

Use opendev.org instead of github.com where appropriate.

Change-Id: Iedcc008b170821aa74acefc02ec6a243a0dc307c
2019-08-11 16:15:34 +02:00
qingszhao 51aec325e6 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: Id83cb3cdd62517045c45388f88cb3de0e3d75da1
2018-06-12 08:26:17 +08:00
Monty Taylor 4187d2fc4a
Add doc/requirements.txt file with doc requirements
The sphinx jobs need to find doc requirements in either
test-requiremnts.txt or doc/requirements.txt. Putting them directly in
to tox.ini, not so much.

Change-Id: I98a43b511a6949fa4f00c26eec224d24d6fa6588
2017-12-18 11:12:42 -06:00
Ian Wienand d2fbcd275d doc: Switch from oslosphinx to openstackdocstheme
Per the manuals migration effort, switch to openstackdocstheme [1]

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I0463f7d39bd72f1d27cfe3f6d5395608b9ed6b29
2017-07-24 10:34:22 +10:00
Doug Hellmann 4db30f9f05 update sphinx
Update sphinx to the version used to build the documentation elsewhere
and turn on the option to treat warnings as errors to ensure that no
poorly constructed rst is introduced. Cap sphinx<1.6.1, since that
version has a conflict with pbr right now.

Change-Id: I19b3332229e2094988cbf8968c42a0323194a209
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-05-21 11:00:04 -04:00
Ian Wienand c8af407eb2 Update to bashate 0.5.1
This minor release of bashate just fixes one small issue with python3
compatability.  This is an alternative to
Ic91b5ce8cb85e376573f9bf3659d2a86cc437179.

Change-Id: Ie5ad29003cf80a332b9a9258749757a15de79966
2016-04-26 17:53:45 +10:00
Andreas Jaeger fdb3883146 Add venv tox environment
This environment is used by the normal docs job, add it.
Manually add requirements needed for doc building.

Change-Id: I1be193d113683966f6a76e862713f3a550543168
2016-04-15 21:06:45 +02:00
Ian Wienand 7cd16ce48a Remove shocco docs and other cleanups
This is a fairly opinionated change to do some spring cleaning on the
documentation.

The current output of shocco as rendered at [1] is completely broken.
I can not see that it is worth us maintaining this.  Honestly, the
github page does a better job at showing the scripts with a bit of
formatting.  The "changes" page is similarly useless today.  cgit or
github show allow browsing of changes in the repo better.  Both are
removed along with support scripts.

When you currently hit the first page, it gives no clue as to what
DevStack actually is.  Add a paragraph explaining that, and link to
the cgit for easy source browsing.

stackrc.rst is not necessary; the stuff about database backends is
already discussed in configuration.rst; move the things about service
repos into a section of configuration.rst.

The discussion in openrc.rst is moved into the configuration.rst file.

localrc.conf.rst was just a paragraph pointing back to
configuration.rst; this is removed.

The variables described in exercise.rst are moved into a separate
section of configuration.rst

[1] http://docs.openstack.org/developer/devstack/#scripts

Change-Id: Ie7f4b265368f1d10a8908d75e11d625b2cc39e7c
2016-04-14 07:55:38 +10:00
Waldemar Znoinski 84d2298d3b Tox: don't check localrc with bashate
Change-Id: I9fc5f9f106184c92e555e25ab09883cbed054ca4
Closes-Bug: #1561500
2016-03-24 12:27:53 +00:00
Ian Wienand c709d50afe Update bashate to 0.5.0
Update bashate to 0.5.0 release.  We got things ready for this with
I3fd5d55236e90c2f2c25243af87adaf0c1b763e2.

I'm not sure what I was thinking in
I9e4b1c0dc9e0f709d8e76f9c9bf1c9478b2605ed when I added ".orig" files
to the list of files to check.  Ignore diff/merge files.

Change-Id: I8bb0c8b39972abb775b4e5556e79d2e17005bc8c
2016-03-07 14:05:48 +11:00
Jenkins c3c91c4267 Merge "Minor fixes for bashate trunk" 2016-02-24 20:04:55 +00:00
Jenkins adbb3b7e1f Merge "Update to bashate 0.4.0" 2016-02-19 01:20:19 +00:00
Jordan Pittier 33df895ffb Tox: don't check stack-screenrc with bashate
Change-Id: I8f04de2cde8a123c3825e7ba22aef1f5b311f61c
Closes-Bug: #1531885
2016-02-17 15:26:33 +01:00
Ian Wienand 7ae97298c5 Minor fixes for bashate trunk
We don't have a new bashate release yet, but this fixes some minor
issues when used with bashate trunk.

The only two things triggered are stricter checking of assignment in
local declartions (catches quotes) and one instance of evaluating
arithmetic result in tools/xen/functions.

Therefore, hopefully, this change has no effect!

Change-Id: I3fd5d55236e90c2f2c25243af87adaf0c1b763e2
2016-02-16 14:50:53 +11:00
Ian Wienand 76d05400ec Update to bashate 0.4.0
Update to bashate 0.4.0.  The biggest change in this is that bashate
does a syntax check with "bash -n" which can be useful

Change-Id: Iff625ef2181dfaba28349dc17de0749faddec539
2016-02-16 14:35:51 +11:00
Davanum Srinivas f59e6df23a Do not fail with Tox 2.3.1
Latest tox causes failures:
   File "/usr/local/lib/python2.7/dist-packages/tox/config.py", line 1140, in processcommand
     argv = list(shlexer)
   File "/usr/lib/python2.7/shlex.py", line 269, in next
     token = self.get_token()
   File "/usr/lib/python2.7/shlex.py", line 96, in get_token
     raw = self.read_token()
   File "/usr/lib/python2.7/shlex.py", line 172, in read_token
     raise ValueError, "No closing quotation"
 ValueError: No closing quotation

This is caused by a backwards incompatible change in tox:
https://bitbucket.org/hpk42/tox/issues/181

Change-Id: Ic28c634cf806394cfa82b61cb45be60b8f40a61a
2015-12-21 08:36:43 -05:00
Ian Wienand 5cdee8dd33 Update to bashate 0.3.2
Bashate 0.3.2 has a few new checks -- firstly make sure some of the
plugins have #!/bin/bash, and fix up a couple of "local" changes that
were missed by I9c8912a8fd596535589b207d7fc553b9d951d3fe

Change-Id: I9e4b1c0dc9e0f709d8e76f9c9bf1c9478b2605ed
2015-10-29 11:30:20 +11:00
Ian Wienand b14f96fb7a Pin bashate and allow for substitution
I want to release a new bashate, but I also don't want to risk
consuming it before fully testing it.  By pinning here, we can run all
our usual CI on new versions before accepting them.

Additionally, allow substitution of the bashate dependency via an
environment variable.  We can use this in a bashate test to substitute
a path to a checkout with any changes applied.

Change-Id: I165c4d66db8b7bdcff235ef7d8c99029637bb76a
2015-10-16 11:47:58 +11:00
Ian Wienand f80c37dd47 Ignore bashate long-line warnings (E006)
Since Ic2532676e46e93f129d590d1fa7a044ef65f50fb bashate warns on
long-lines.  Traditionally, for whatever reason, devstack hasn't cared
too much about long lines unless it really damages readability.

So ignore this to avoid thousands of warnings on the long lines.  Note
even though released bashate doesn't have this, ignoring a missing
test doesn't matter.

Change-Id: I16aeaa3b334fac1eec5085f2cfe26c81c53023a8
2015-10-06 20:19:38 +11:00
Jenkins c717d50923 Merge "Documentation for single interface Neutron networking with OVS" 2015-06-09 23:00:12 +00:00
Sean M. Collins 02ae50dc99 Documentation for single interface Neutron networking with OVS
Change-Id: I7a72377f55952db629c2ce7ba4ed648635e581ef
2015-05-29 11:32:45 -04:00
Tony Breeds 31127a2a74 Skip 'shocco' code when running tox
when running tox in a devstack directory where you have previously run tox
-edocs the bashate testenv will fail as the shocco code doesn't match the
devstack style.

eg:
---
E003: Indent not multiple of 4: '           2>/dev/null ||'
 - /home/stack/projects/openstack/openstack-dev/devstack/shocco/shocco.sh : L352
<snip>
27 bashate error(s) found
---

Take the easy path and avoid running bashate in the shocco dir.

Change-Id: I5b0155332ec994afaffc5c5961902281864cff61
2015-05-29 12:21:09 +10:00
Sean Dague 5e5a29cc8c fix bashate target
there was a missing -or which meant we weren't running this on most of
the files in the repository.

Change-Id: If926afc8f12f6beb80d7a9af7c787b3dcc360a89
2015-04-03 08:52:29 -04:00
Dean Troyer bf2ad7015d Move configuration functions into inc/*
* config/INI functions from functions-common to to inc/ini-config
* local.conf meta-config functions from lib/config to inc/meta-config

Change-Id: I00fab724075a693529273878875cfd292d00b18a
2015-03-09 22:52:19 -05:00
Dean Troyer b3fdb1c935 Simplify docs build
Remove unnecessary old code from tools/build_docs.sh; it now only builds
docs for the current branch in the current working directory.

Fix the merging if the git log changes into changes.html.

Change-Id: I965dc3383b6317807ca0d47fe42648a19e96b57b
2014-11-17 12:45:12 -06:00
Ian Wienand 46b0be3137 Fix up file-matching in bashate tox test
The current test does not match file files in /lib/* because the
-wholename command is missing the preceeding \*.  The whole command is
a little difficult to understand.

This re-lays the find command, using -prune to skip dot directories
and keeping a hopefully clearer flow of what is being matched.

Change-Id: Idd856e897ff97095fb116294a9187ff4b198fa26
2014-10-29 11:21:07 +00:00
Sean M. Collins 09e550c370 Convert all HTML doc to RST
The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-22 12:27:00 -04:00
Monty Taylor ebb983d3f2 Make the tox docs env build the docs
The tools/build_docs script builds the docs for devstack. Use it.

Change-Id: I530ff6c8090f2c58160cb11bee35534b79db52ed
2014-10-14 12:13:07 -04:00
Monty Taylor 81fa6c7b4b Add docs environment to tox.ini
As per the governance resolution https://review.openstack.org/119875,
projects should have a docs environment in their tox.ini testing
interface. Add one.

Change-Id: Ib3548bc23713e120089ae29b5c4e851de48cf8d3
2014-09-09 10:06:46 -04:00
K Jonathan Harker 0c256abd76 Use tox for bashate testing
Create a tox.ini file to install bashate into a virtualenv for running
tests. It can be run with a command such as "tox -v -ebashate". The find
command being used is equivalent to the default list of files discovered
by bashate plus the exclusion of the .tox/ directory. Also add the .tox/
directory to the .gitignore file.

Change-Id: I94cab4e4a9118d62edfce29ead1f1e2a5f48e529
2014-08-20 12:53:42 -07:00