* Update cookiecutter from branch 'master'
to b1454984311062b69f0f11c8d0950a17877fdc4c
- Remove unicode literal from code
All strings are considered as unicode literal string from Python 3.
This patch drops the explicit unicode literal (u'...')
appearances from the unicode strings.
Change-Id: Iaff03aaf0bad069f5d7b78ed0a6d209e36e19884
* Update cookiecutter from branch 'master'
- Fix docs whitespace
Too aggressive trimming caused lines and indents to go lost.
This patch makes docs whitespace just right (TM).
Change-Id: If10bc6cb10c8cd26bb7ea7a071d9f0e4f34235b5
* Update cookiecutter from branch 'master'
- Remove unused Babel setup
We don't need the translation settings in setup.cfg anymore, remove
them - and remove babel.cfg.
Add Python 3.8 to setup.cfg.
Change-Id: Ia912d1d3ee2e2f95cbd56984a32d1153d758977c
* Update cookiecutter from branch 'master'
- Switch to newer openstackdocstheme and reno versions
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
* Update cookiecutter from branch 'master'
- Update hacking version of new repo
Update to version 3.0 of hacking.
Change-Id: I011bba5356ad6c253cbba3816b05885fe12abacc
* Update cookiecutter from branch 'master'
- Update CONTRIBUTING
Sync {{cookiecutter.repo_name}}/CONTRIBUTING.rst with CONTRIBUTING.rst,
we should use the same content that we push everybody else to use.
Change-Id: Iff1e4d49bb88b84e96be097bbfd8a5cba5932df1
* Update cookiecutter from branch 'master'
- Fix links formatting for the contributing documentation
Ensure that
- the URLs shown on a single line are properly aligned (3 spaces);
- bug tracking URLs are rendered on their own separate line,
removing the space chomping Jinja operators around the
expressions.
Change-Id: Ice9b73e6e42071b954a9b8058ab34799ee6cce89
* Update cookiecutter from branch 'master'
- Merge "Minimise info in CONTRIBUTING.rst"
- Minimise info in CONTRIBUTING.rst
This reverts commit ed3a0b07c72667628064dc7c5d8eae47dcae16d6 so that the
CONTRIBUTING.rst file contains only the same information that it
historically had, plus adds links to the canonical OpenDev repo and the
new project-specific contributor documentation.
It also links to the new quick-start page in the Contributor Guide
instead of the OpenStack Infra manual, as the latter is expected to be
moved to OpenDev and scrubbed of OpenStack-specific information.
This has the effect of minimising the amount of information contained in
each repo's CONTRIBUTING file, in favour of keeping it in one place in
the Contributor Guide that can easily be kept up to date.
The content of the new project-specific contributor docs template is
moved back to the docs tree, with some minor cleanups, instead of
transcluding it.
Change-Id: I02dd34a1cf6b62d12f7a26d21b3a2857d82d1b0a
Depends-On: https://review.opendev.org/708939
* Update cookiecutter from branch 'master'
- Update the minversion parameter.
Update the minversion parameter to use the python -m pip to install
python packages:
https://tox.readthedocs.io/en/latest/changelog.html#id185
It's recommend to use this.
Change-Id: Iac4f45c266d0ae08d71814c6667ae3fde9f042a7
* Update cookiecutter from branch 'master'
- Fix Contributing template location
There were several discussions[1][2] on includes and
where the template should actually be living for the U
community goal about contributor docs.
Having the information in CONTRIBUTING.rst so that it
appears on github and using an include in
doc/source/contributor/contributing.rst to pull that text
in via Sphinx is a cleaner way of keeping all the info
together.
[1] https://review.opendev.org/696001
[2] https://review.opendev.org/#/c/707735/
Change-Id: I2bcda1e0f14dac7843869666df4250604b64c265
* Update cookiecutter from branch 'master'
- Fix gitreview host name
This can cause issues with release automation when the repo is tagged
since the host will not match what is expected for the ssh key.
Change-Id: I9da46114b5bea201593bcba4ec23753f8c97fa04
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
* Update cookiecutter from branch 'master'
- Merge "Update CONTRIBUTING.rst template"
- Update CONTRIBUTING.rst template
As a part of the Ussuri Community Goal, the template here needs to
expanded to outline the things that are consistenly different between
projects or different from the norm that should be documented so that
new contributors can more easy onboard themselves to a given project.
Goal Patch: https://review.opendev.org/#/c/691737/2
Change-Id: I41381f2ae8a641b8d9052ee8872a460e65c56630
* Update cookiecutter from branch 'master'
- Update the python version in envlist attribut.
Update the python 3 version with the latest stable. Remove the python 2
version. The support of this version is soon finish.
Change-Id: Id80849594d43977a5e058f2b88ef3b6ddda5d072
* Update cookiecutter from branch 'master'
- Stop configuring 'install_command'
Currently, we are overriding 'install_command' to use 'pip'. This is
considered poor behavior and 'python -m pip' should be used instead.
https://snarky.ca/why-you-should-use-python-m-pip/
It turns out that this is the the default value provided by tox:
https://tox.readthedocs.io/en/latest/config.html#conf-install_command
So we can remove the line and simply use the default value.
Change-Id: I591475707205732e68e3e68231c417acf672277b
* Update cookiecutter from branch 'master'
- Update URLs
This commit updates some URLs. All of our docs.openstack.org supports
HTTPS already. And, some of the URLs are outdated.
Change-Id: I49056e5bd196e5cca2faaa8f5bc34b56c89ff675
* Update cookiecutter from branch 'master'
- Fix outdated references to git.openstack.org/cgit/
This is a follow-on from the previous OpenDev migration patch,
which catches a few remaining references to cgit, and changes
them to point to the new opendev.org gitea instance.
Change-Id: I64d2d840073e6fa0e6af08ca950b32c8fe248e37
- OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:
http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.htmlhttp://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html
Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
- Update contact address to openstack-discuss ML
The openstack-dev mailing list has been retired and its
conversations now take place on openstack-discuss instead.
http://lists.openstack.org/pipermail/openstack-dev/2018-November/136501.html
Update this cookiecutter so that new projects don't copy over the
obsolete ML name.
Change-Id: Idadd91db3ea68bc0b62616640a98f60e283d1a73
- Update the outdated URL in README.rst
Change-Id: I613b9d5f1ac3f599a38dc648daad70de9864460f
- Clean up .gitignore references to personal tools
Developers run all sorts of different tools within Git repositories,
any of which can leave their own special trashfiles all over the
place. We can't every hope to catalog them all, so better to
recommend developers simply configure a global core.excludesfile to
filter the irrelevant files which tend to get created by their
personal choice of tools.
To this end, remove the long-standing sections for "Mr Developer"
and "Editors" since their mere existence here sends the signal that
we welcome (and have time to review) additions for any old tool
someone ever might happen to try. Also add a comment block
explaining this, for clarity.
We can, and should of course, continue to list files created by the
tools recommended by our workflow (test frameworks called from tox,
documentation and packaging builds, et cetera).
Change-Id: Ib58a57267b064e4142686de6c37a70dbff04b9a7
- Merge "Convert to new docs PTI"
- Convert to new docs PTI
https://governance.openstack.org/tc/reference/project-testing-interface.html
Change-Id: I1f6debad924f68f6d0bf6fc04113614ef4b7a0b0
- Merge "Fix quotes and undefined variable"
- Fixed two issues regarding cookiecutter template
- cookiecutter.json was using single quotes which is not JSON valid
- there was a typo in CONTRIBUTING.rst:
"cookiebutter" instead of "cookiecutter"
Change-Id: I102b31b8152d2c9f2af8bbd3fca555eae50b3b42
- Fix quotes and undefined variable
Replace single quotes for double ones in cookiecutter.json,
otherwise it leads to a decoding error.
Fix a typo in a variable name.
Change-Id: Iccc74d1d9a3d6b9757476adde4418d81e215152a
- Add support for storyboard
Also, add html_last_updated_fmt, which openstackdocstheme has been
adding to everything.
Change-Id: Ie3f8f4f095c4244c51615c9dcfd903305a02f017
* Update cookiecutter from branch 'master'
- Merge "Switch to use stestr in README"
- Switch to use stestr in README
This commit fixes to use stestr and one typo in README.rst.
Change-Id: Ie4ff7b64631548ff36edef35756b9e9ab259a687
* Update cookiecutter from branch 'master'
- Update Python versions only py27 and 35
This commit updates Python versions to use only python 2.7 and 3.5. We
use them in our CI now. So, we don't need to have the other versions
in this cookiecutter.
Change-Id: I1cd89ff5159a00320e142d0bbfc751f74c0b4663
* Update cookiecutter from branch 'master'
- Merge "Fix docs.o.o URLs"
- Fix docs.o.o URLs
The documents are not published anymore to /developer/, fix links.
Use https for these links.
Change-Id: Ief881a8e5fadd2f8e8f1c73ebc853736532a6432
* Update cookiecutter from branch 'master'
- Switch to use stestr as the default test runner
This commit switches from using the pbr testr wrapper script to use
stestr as the test runner.
Change-Id: I42c4a14d9e4366a621129d2c158fe57a8fc4b30e
Project: openstack-dev/cookiecutter 0af64c7c00f3ba0a3af1751c82131fc20c8ed472
Fix errors found from making a project
The pbr version is tied to the repo-name - that is, the name that we
register with PyPI. It takes the argument 'python-novaclient' not
'novaclient'.
Nothing we do is Copyright OpenStack Foundation. There isn't a good
answer for a single-line copyright statement such as is found in sphinx
config files, but "OpenStack Foundation" is definitely wrong.
Add some line wrapping so that the releasenotes conf file doesn't fail
pep8.
Change-Id: Id237331c279b7acb848a28d167ad88d63de6f140
Project: openstack-dev/cookiecutter bfc8f956e3fe0570c7445e88ea1bbd03f699e9d5
Remove pbr version from setup.py
Using pbr version in setup_requires is no longer recommended by Pbr.
Change-Id: I671ca2509d27640e5f4f3f7ec1f1980bcbb42a23
Project: openstack-dev/cookiecutter c960f2609894c64d49334972e2a7682c3de6b63b
Update to the Pike document structure
In this change the documents folder changed in the following way:
- Folder structure follows the Pike structure defined in [1]
- Structure of Install guide is added as it is moved into
the doc folder.
[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: Ia58725958d64fba81a5c4661b2686cd643eaa426
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
Project: openstack-dev/cookiecutter b52e5f2f14692364333a5b7bc6993fe1f133d15b
Update for openstackdocstheme 1.11
Update for most recent openstackdocstheme, use it for releasenotes as
well.
Change-Id: I0a04bb69553c30f23091444ef893f854bbf6e857
Project: openstack-dev/cookiecutter 9fd9e035f0db2970ef83e88fdc991de63231f121
Update test-requirements.txt to latest
The 1.6.1 release of sphinx has introduced a couple of backwards
incompatibilities that break our doc and release notes builds. Block it
until we can work around the issue.
Change-Id: Ief714bba21edfd72609056659be517227dbb52f5
Project: openstack-dev/cookiecutter d676034d1cafd1fd17be6ebf5c4323415b5358d8
Remove testsenarios from test-requirements.txt
Not all projects use testsenarios, so don't keep it in
test-requirements.txt.
Change-Id: I50c315d203eae81646f32bd71d2ec282459d4396
Project: openstack-dev/cookiecutter a1d2380180e6d05c91ad921cf24e415282dd7215
Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. We should
enable this by default to prevent suprise for users.
Change-Id: Iff674c6b8a2f9d8d898817d1995a08674a8416a4
Project: openstack-dev/cookiecutter 9d85970e8ef6831072385a5ad8eee0e6ad4c433b
Remove 'build_releasenotes'
Looks like this was a half-finished idea that was never implemented in
reno. No need to keep it around.
Change-Id: I3d0cc28bb7891f63116d2160dadfcf2e6e05d693
Project: openstack-dev/cookiecutter a293dcabe8e0aacaeba0652455c4475b3f46f0da
Sync with global-requirements
* Update test-requirements to match global-requirements
* Bump pbr to 1.8 to match global-requirements
* Update setup.py to match global requirements version
Change-Id: I32879b6a2f446e434dc5740a4f2c2ad46b0824b5
Project: openstack-dev/cookiecutter f619226d342b3be7c458c665cce6aab8d250cd8a
Use launchpad_project in CONTRIBUTING.rst
This template has an option for launchpad project, but it is not used in
CONTRIBUTING.rst. Fix that.
Change-Id: I60d9b79eea7d9ad57b26bdc24f8cb02d3f2a1ccd
Project: openstack-dev/cookiecutter b05ebb1f266fbb94db940ad93dc88ef23eee7a02
Sync latest requirements.txt
This is follow up of 03d1b4f141435de8071ba78026dfe62af280fc48
Change-Id: Ica5767695920d8b912375fdc0f8bb3aba9254898
Project: openstack-dev/cookiecutter c2a6a1b041421a626f70540260f20a78744f0c0c
Add locale_dir for translation of releasenotes
To translate releasenotes, add variable localedir to releasenotes'
sphinx conf.py.
For details, see also:
http://lists.openstack.org/pipermail/openstack-i18n/2016-October/002486.html
Change-Id: Id6bf9dccd62ffe0b10819a9d54da9c8cf457527b
Project: openstack-dev/cookiecutter 30b9b2016cb5c962c2fd1d58e832c910fac9dc4b
Enable Python DeprecationWarning in test environments
Many deprecations are triggered early (on imports, for example)
before the warnings are enabled by test cases.
Enable deprecation warnings in test environments via the
PYTHONWARNINGS environment variable.
Change-Id: I075a30d6052f49c6157f9842dfd1934ea1dcb583
Project: openstack-dev/cookiecutter 2cf26bf0a326cb9a837a369206ac3b1d674a15c2
Adjust tox.ini for constraints
Projects can now use constraints everywhere in tox.ini, remove the
outdated X-constraints environments that are nowhere used. Instead add
constraints useage to the install command.
Change-Id: I5ec16384a5d8a0a68954d0c3f30bc4154bbd606d
Project: openstack-dev/cookiecutter 29a3238a073d3d4e917adc58b288c4de2ce05cda
don't need to omit this as oslo libs are now used
Change-Id: I742a2ac1140cdc69feb1f61aef89c7f03b4ed3c7
Project: openstack-dev/cookiecutter 03d1b4f141435de8071ba78026dfe62af280fc48
sync latest requirements.txt
Took me a while to fight getting these things updated. Hopefully this should
save someone a little time before they fall out of date again.
Change-Id: Ib55006eda96eda2d7d3e347de1337653083e5c5a
Project: openstack-dev/cookiecutter 0173c4e113fe4b477d8b593cceab16d38e83725a
Change copyright year in sphinx conf file to 2016
Change-Id: If933cbc0ec1a55d9d849781b7e548eecccda31a6
Project: openstack-dev/cookiecutter 5c5f7c3996f1f0f739f33d19df86ff493afb1d4c
Don't include openstack/commmon in flake8 exclude list
The directory openstack/common was used to keep codes from
oslo-incubator, we have graduated some separated libraries.
Don't use the directory any more.
Change-Id: I7bfb899f8b94e4dc19fd4cef43466a5baac3a3ec