As per the current release tested runtime, we test
python version from 3.8 to 3.11 so updating the
same in python classifier in setup.cfg
Change-Id: I8ce3e066121e6e07f05ed886eccdd22e1c66c6d3
In Zed cycle testing runtime, we are targetting to drop the
python 3.6/3.7 support, project started adding python 3.8 as minimum,
example nova:
- 56b5aed08c/setup.cfg (L13)
Also indicates that we support python 3.9.
Change-Id: I298bf00067bd877e4d29cddd15512b9e7fda3bf3
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg:
* Wheel is not needed for python 3 only repo
- Update classifiers
Change-Id: I391f53925c1b20d2e8ad1685358c81dcbdaaf34c
- pbr hasn't need the hook configuration since forever [1]
- The 'wheel' group is renamed to 'bdist_wheel' [2]
- Update the urls to latest
[1] c84876dc0f
[2] f7c9878712
Change-Id: I52e7abcb577e3a9ba61492e84a3c148f6eab4b4a
Use sphinx-build and cleanup unused config.
Switch to openstackdocstheme 1.20.0 and remove obsolete settings from
conf.py files.
Update some RST files, they had wrong indentation.
Change-Id: Iaad2841db809f8a343fb8b1031cf8d0587d70442
There were a couple of scripts here:
- prettify.py
- remove_trailing_whitespaces.sh
- remove_unnecessary_spaces.py
- retf
Most of them are self-explanatory with the exception of 'retf', which I
don't understand but which looks untouched in years and therefore
useless. For the other three, we have tooling in place to ensure these
"issues" don't get into source control and, even if they did, there's
questionable value in rewriting stuff just to remove excess whitespace.
Kill them all.
Change-Id: Ifbd2d50a669251484056552da21d23906f8d6178
The 'openstack-auto-commands' command has been superseded by the
'cliff.sphinxext' Sphinx extensions [1]. Remove both this and the helper
script in 'bin/doc-tools-update-cli-reference'.
[1] https://docs.openstack.org/cliff/latest/user/sphinxext.html
Change-Id: Ia20ace51377290997566b89ad4f78a941358cb86
Python 3.3 is not supported from Mitaka, as per Infra.
This patch removes the support for the same.
Change-Id: I7cd467af595c5e96df599b16afb83ef59f4d4452
Add Python 3.5 as trove classifier to setup.cfg.
We don't run any unit tests but expect that Python 3.5 works.
Change-Id: I231c2beaaf90c7da0185758829b0b9ddb216eba6
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.
Remove openstack-doc-test together with all support files.
Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
Split up draft guides under separate heading and remove draft word for
easier review.
The output looks now basically like:
Generated documents
admin-guide-cloud
contributor-guide
networking-guide
user-guide
user-guide-admin
Draft Guides
arch-design-rst
config-ref-rst
image-guide-rst
install-guide-debian
install-guide-obs
install-guide-rdo
install-guide-ubuntu
Also, create separate tool openstack-indexpage that only generates index
page.
Change-Id: Ic68a674918f18dc37f8b9fa4e9d9f529a8ad131e
Since the hot-ref and hot-guide are going back to the heat repository,
some tools are not needed anymore:
- dn2osdbk
- the hotref sphinx extension
Change-Id: I9f8539f73b4dedc5236f8ff5d5b03c93c602c661
Depends-On: Ie2240d2fca5d6e43b1d186645e7ff9107514f289
check_output returns bytes, add extra argument universal_newlines so
that the output is a string and thus can be used by other functions.
openstack-doc-test should work now using python 3 and python 2, thus
enhance setup.cfg to mark python 3 support.
Change-Id: Ic9873702977acad63d94c426c0c7e69f331a1360
Remove check_output that is in python 2.7 and newer but not in
python 2.6. Thus, we do not support python 2.6 anymore.
Change-Id: Ie953ce43d792b95e348a55fea4665b1ef59b468d
doc-tools-update-cli-reference is a wrapper script to update
CLI references in the openstack-manuals repository.
Change-Id: I27f81d783db70206e4fdd1110da354bc9df90b70
Universal is used to identify pure-Python module(by bdist_wheel).
For these, it is sufficient to build a wheel with _any_ Python ABI
version and publish that to PyPI (by whatever means).
Change-Id: I83c09e2d2658280fd799675e9ef290841b2cd087
This is an initial import of an improved version of tools/test-languages.sh
used in repositories like openstack-manuals or security-doc.
Following improvements are included:
* add missing license header
* fix E003: Indent not multiple of 4
* fix E020: Function declaration not in format "^function name {$"
* rename variables inside methods
* rewrite usage information
* refactor/rename methods (test_fr, test_ja, test_language, setup_lang)
Change-Id: I9fead76f6552fd3f7317605f1e6a0f9cf5b69b26
This tool converts docutils native XML to docbook. The conversion is
done using XSLT, with some custom XML treatment.
The XSL source is a slightly modified version of Dn2dbk written by Éric
Bellot (http://ebellot.chez.com/dn2dbk/index.htm).
Modify doctest to check and build the HOT guide.
Implements: blueprint heat-templates
Change-Id: If866a5ffe19165c38981493684de550e0df0e36d
A recent change renamed main in doctest.py to doctest, this needs a
corresponding change in setup.cfg to fix package building.
Change-Id: Ic75db791af98b775a212e93b25548028f6d7ca53
Add a new script that can reformat JSON files and check for niceness.
We can use this later as niceness check for openstack-doc-test.
Change-Id: I33c5309bfa2e1abfa6a35d1cfcdc984775e85f05
The tool scripts used common functions, merge them to a single file
with different entry points.
Cleanup the merged file so that it passes the pep8 test.
Install the commands now as openstack-generate-docbook and
openstack-generate-pot. Leave a compatibility wrapper which should be
removed in version 0.8.
Change-Id: I7e4d651c4c62df58499e64e38528cb2cc4e9175b
build-ha-guide.sh and markdown-docbook.sh are only needed by doctest.py,
so make them only available to that tool. There's no need to install
these files in /usr/bin.
Change-Id: Idd2f40dbe0a50a0936311574a26553444a4dd7e1
No need to put 'usr/' in front of data files, distros have the default
prefix set to '/usr' already such that 'setup.py install' does the right
thing. Compare with the results of 'python setup.py bdist'.
Change-Id: I8d7f592abece22f8bb70deede776509cdd1446e5
Call "os_doc_tools/commands.py" nova to generate a file
section_cli_nova_commands.xml with the command line options.
Allows generation of all supported clients with --all command.
The tool gets installed as: openstack-auto-commands
blueprint os-user-doc
Change-Id: Ie4b200818bd585d3fce0b27f0639ad03069b3b7b
Update for using sphinx package so that documentation
follows the OpenStack python packaging conventions.
This contains an initial man page for the openstack-doc-test
tool.
Change-Id: I8b8ed63c3c7bcfb58f5d8f939a79c3f7c314b969
Add new parameter --version
pbr uses version number from git (via tags), so remove our own
version number. Once we tag a version "0.1", this will be the
version number.
Change-Id: Idcf9e4ddeebf637eb36797afd2855d1c657e52ea
This is an overhaul of the complete content to make it
a separate python package that can be installed on the jenkins
machines as well as on editor's machines.
The goal of this patchset is to package everything
and get the command "openstack-doc-test" running so that
it can be used for gating.
This will need further refinement for the other commands.
Change-Id: Icc2f1807dd5ab5fb2f83c05d1b3895b3a9a0dbaf
Ghanshyam Mann