f0c5a38fcb
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I3984c5b0a99f5dd1224ebd29b16ebbef14225f49 |
||
|---|---|---|
| hooks | ||
| releasenotes/notes | ||
| {{cookiecutter.repo_name}} | ||
| .gitignore | ||
| .gitreview | ||
| CONTRIBUTING.rst | ||
| README.rst | ||
| cookiecutter.json | ||
README.rst
cookiecutter-openstack
Cookiecutter template for an OpenStack project. See https://github.com/audreyr/cookiecutter.
- Free software: Apache license
- pbr: Set up to use Python Build Reasonableness
- hacking: Enforces the OpenStack Hacking Guidelines
- stestr: Runs tests using stestr
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.7
- Sphinx docs: Documentation ready for generation and publication
Usage
Install cookiecutter:
pip install cookiecutterGenerate a Python package project:
cookiecutter https://opendev.org/openstack/cookiecutter.gitOpenStack projects require a working git repo for pbr to work, on newer versions of cookiecutter (>= 0.7.0 released 2013-11-09) this initial commit will be done automatically. Otherwise you will need to init a repo and commit to it before doing anything else:
cd $repo_name
git init
git add .
git commit -aThen:
- Add the project to the OpenStack Infrastructure