62e5b0c629
There is some additional setup required for the docs to be built. We need to have an implementation so there is something to add to the api docs, and openstackdocstheme requires a git commit so it can get the last modified timestamp. Also, we no longer generate a Changelog since we aren't using pbr now so we need to remove that or we have a missing file. Change-Id: Ic79aa0fb8f7e5813bec420c8b2690b0e9ef79cc2 |
||
|---|---|---|
| oslo.{{cookiecutter.module_name}} | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| README.rst | ||
| cookiecutter.json | ||
| tox.ini | ||
README.rst
oslo-cookiecutter-openstack
Cookiecutter template for an Oslo library (part of the 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
- testrepository: Runs tests using testrepository
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3, 3.4
- Sphinx docs: Documentation ready for generation and publication
Usage
Generate a Python package project:
cookiecutter https://opendev.org/openstack/oslo-cookiecutterOslo libraries require a working git repo for pbr to work, so you need to init a repo and commit to it before doing anything else:
cd oslo.$module_name
git init
git add .
git commit -aThen:
- Add the project to the OpenStack Infrastructure