openstack
/
oslo-cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new Oslo libraries
138 Commits 1 Branch 0 Tags 703 KiB
Python 83.4%
Shell 16.6%
Go to file
Adam Spiers 61a80f07ac make tox docs environment follow PTI guidelines for sphinx build 
https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
says:

    Note:

    We strongly discourage project teams from adding commands to the
    docs environment beyond:

        sphinx-build -W -b html doc/source doc/build/html

Discussion on #openstack-doc prompted the suggestion to adjust the
cookiecutter templates accordingly:

http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2018-08-09.log.html#t2018-08-09T16:04:54

Also update requirements.txt.

Change-Id: I8f23c82405692e9984ed1089fa44ac25cbc27aeb
 		2018-08-09 18:57:29 +01:00
oslo.{{cookiecutter.module_name}} make tox docs environment follow PTI guidelines for sphinx build 2018-08-09 18:57:29 +01:00
tools Add test script 2014-07-28 09:49:24 -04:00
.gitignore Ignore created boilerplate/ dir. 2013-08-16 20:59:16 +02:00
.gitreview Fix .gitreview and use of oslosphinx 2014-02-18 08:47:29 -05:00
.zuul.yaml Move tox job in-tree 2018-01-28 11:44:33 +01:00
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 2015-05-16 13:15:50 +00:00
README.rst Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:16 +00:00
cookiecutter.json Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
tox.ini Add test script 2014-07-28 09:49:24 -04:00

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://git.openstack.org/openstack-dev/oslo-cookiecutter.git

Oslo 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 -a

Then:

  • Add the project to the OpenStack Infrastructure