New setuptools is auto discoverying multiple package dirs in our repo
because multiple top level dirs contain python content. While auto
discovery excludes common dirs like doc/, testinfra/, and tools/ others
are not excluded from discovery like playbooks/ and docker/. This
results in an error as auto discovery is only valid if a single possible
package dir is discovered.
It would be preferable to exclude the additional dirs instead but I
can't seem to find a way to do that. The documentation can be found at:
To workaround this we tell setuptools to not auto discovery packages by
setting an empty packages list in setup.cfg. Then we rely on PBR to do
its job and find the package content via git repo information.
There's a bunch in here. This is mostly big-ticket things and test
fixes. Also, change the README to rst - because why is it markdown?
This modernises the openstack-infra documentation by switching to
openstackdocstheme. Update dependencies as required.
To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.
It seems later sphinx has included it's own ":file:" role which now
conflicts. Change it it ":cgit_file:" in our documentation. Remove
the custom header template which no longer applies. Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)
The existing ci-docs job is a one off job that was configured by hand.
Define the ci-docs job as a Jenkins Job Builder job using the existing
To make the existing utilities work within the puppet repo the doc files
have been moved to doc/source, setup.cfg added to build docs in the new
dir, setup.py builds openstack-ci-puppet (instead of nova), tox now has
a venv virtualenv, and the .gitignore has been updated appropriately.
Approved: James E. Blair <email@example.com>
Reviewed-by: James E. Blair <firstname.lastname@example.org>