Commit Graph

203 Commits

Author SHA1 Message Date
LiZekun d13ff9ac8b Update python testing classifier
Yoga testing runtime[1] has been updated to add py39
testing as voting. Unit tests update are handled by the
job template change in openstack-zuul-job

- https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/820286

this commit updates the classifier in setup.cfg file.

[1] https://governance.openstack.org/tc/reference/runtimes/yoga.html


Change-Id: I4f03a44bc5da0e16b4b1835a69cb22faa9c89f6d
2022-03-22 12:30:15 +00:00
LiZekun b145498431 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
2022-03-04 05:55:09 +00:00
Radosław Piliszek f1036368c7 Fix docs whitespace
Too aggressive trimming caused lines and indents to go lost.
This patch makes docs whitespace just right (TM).

Change-Id: If10bc6cb10c8cd26bb7ea7a071d9f0e4f34235b5
2020-07-23 14:55:10 +02:00
Andreas Jaeger 7a00abb676 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
2020-05-26 08:15:18 +02:00
Andreas Jaeger f0c5a38fcb 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
2020-05-26 08:14:11 +02:00
Andreas Jaeger 0ea9742f28 Update hacking version of new repo
Update to version 3.0 of hacking.

Change-Id: I011bba5356ad6c253cbba3816b05885fe12abacc
2020-03-30 21:41:59 +02:00
Andreas Jaeger 02e6702c9f 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
2020-03-21 08:54:52 +01:00
Zane Bitter abf425e3d0 Autofill bug tracker link in contributor docs
Change-Id: Idb1385f9e5a679ca7fa473ad9e2b3c7f7d6da215
2020-03-06 11:46:45 -05:00
Luigi Toscano 69ae03c0d2 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
2020-03-05 10:22:53 +01:00
Zuul 1af121e0e5 Merge "Minimise info in CONTRIBUTING.rst" 2020-03-03 22:55:40 +00:00
Zane Bitter 7bfef146ff Minimise info in CONTRIBUTING.rst
This reverts commit ed3a0b07c7 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
2020-02-24 15:51:19 -05:00
Daniel Bengtsson 6cf508fea9 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
2020-02-21 10:50:59 +01:00
Kendall Nelson ed3a0b07c7 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
2020-02-18 12:53:22 -08:00
Sean McGinnis c96fee6049 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>
2020-02-18 11:02:40 -06:00
Hervé Beraud 4fbd387dda [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in Ussuri cycle.

Complete discussion & schedule can be found in
-
http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I660a50d89af2cccdd23c161daf581ebdb89ce9e8
Sem-Ver: api-break
2020-02-06 10:27:58 +01:00
Zuul df15066753 Merge "Update CONTRIBUTING.rst template" 2020-01-16 19:30:59 +00:00
Kendall Nelson 2eab7591ef 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
2020-01-07 07:30:55 -08:00
Hervé Beraud cd25bd04ad Remove py27 support for future projects
Change-Id: I740c1f7a3ef14c342b3213dca8faeb02e66736bb
2019-11-14 15:33:41 +01:00
Daniel Bengtsson b67d3d35c7 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
2019-11-14 15:22:21 +01:00
Daniel Bengtsson c3d9c9fc71 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
2019-11-14 11:15:54 +00:00
Masayuki Igawa dabf93f528
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
2019-09-04 22:47:15 +09:00
Adam Spiers e844906ec0 Add a testenv for lower-constraints
Give projects a testenv for testing lower constraints by default, as
suggested by Tony in the recent Requirements project update in Denver:

    https://youtu.be/55ZlXiuiLCo?t=159

and by Dirk:

    https://review.opendev.org/#/c/657444/2/%257B%257Bcookiecutter.repo_name%257D%257D/tox.ini@8

Change-Id: I2456a477ab3f36d2b63420c502bc5409770a4712
2019-06-19 21:34:11 +01:00
Adam Spiers 3acc743d84 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
2019-05-22 15:08:18 +01:00
OpenDev Sysadmins 97446fb5bb 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.html
http://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.
2019-04-19 19:40:16 +00:00
Jeremy Stanley f514f6956e 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
2018-11-30 18:53:23 +00:00
melissaml 638c080071 Update the outdated URL in README.rst
Change-Id: I613b9d5f1ac3f599a38dc648daad70de9864460f
2018-09-23 17:18:03 +08:00
Jeremy Stanley da86f5e042 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
2018-08-16 15:13:50 +00:00
Zuul 69779bff6b Merge "Convert to new docs PTI" 2018-06-12 18:57:38 +00:00
Zane Bitter 122571a4ce Convert to new docs PTI
https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: I1f6debad924f68f6d0bf6fc04113614ef4b7a0b0
2018-06-08 18:12:09 -04:00
Zuul 1ca37227af Merge "Fix quotes and undefined variable" 2018-06-08 10:57:11 +00:00
v-francoise f364eaf18b 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
2018-06-02 13:42:46 +02:00
Martin Kopec 0312bd7a2f 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
2018-05-21 09:11:47 +00:00
Monty Taylor 4f9fc77118 Add support for storyboard
Also, add html_last_updated_fmt, which openstackdocstheme has been
adding to everything.

Change-Id: Ie3f8f4f095c4244c51615c9dcfd903305a02f017
2018-05-07 16:57:23 +00:00
Zuul b73d89dc9f Merge "Switch to use stestr in README" 2018-01-08 14:48:40 +00:00
Masayuki Igawa 009d278d86
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
2017-12-25 16:44:00 +09:00
Masayuki Igawa 006a866691
Switch to use stestr in README
This commit fixes to use stestr and one typo in README.rst.

Change-Id: Ie4ff7b64631548ff36edef35756b9e9ab259a687
2017-12-25 14:17:45 +09:00
Zuul c323c5ae0b Merge "Fix docs.o.o URLs" 2017-10-19 10:45:05 +00:00
Matthew Treinish 0c03474288 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
2017-09-22 10:32:02 -04:00
Andreas Jaeger 962ead432d Fix docs.o.o URLs
The documents are not published anymore to /developer/, fix links.
Use https for these links.

Change-Id: Ief881a8e5fadd2f8e8f1c73ebc853736532a6432
2017-09-07 16:34:01 +02:00
Jenkins 0af64c7c00 Merge "Fix errors found from making a project" 2017-07-14 13:06:39 +00:00
Jenkins bfc8f956e3 Merge "Remove pbr version from setup.py" 2017-07-14 02:34:02 +00:00
csatari c960f26098 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>
2017-07-11 12:37:40 +02:00
Rajath Agasthya 3c97744f73 Remove pbr version from setup.py
Using pbr version in setup_requires is no longer recommended by Pbr.

Change-Id: I671ca2509d27640e5f4f3f7ec1f1980bcbb42a23
2017-07-10 13:02:09 -07:00
Monty Taylor 87d312127f
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
2017-07-10 14:44:56 -05:00
Andreas Jaeger 622da75739 update releasenotes conf.py
Remove glance, replace with module name.

Change-Id: Ifbb110b5c0df59374b629e919d4d5d09dcb0fc34
2017-07-02 10:51:23 +02:00
Andreas Jaeger b52e5f2f14 Update for openstackdocstheme 1.11
Update for most recent openstackdocstheme, use it for releasenotes as
well.

Change-Id: I0a04bb69553c30f23091444ef893f854bbf6e857
2017-06-29 11:53:09 +02:00
Doug Hellmann 722548cff0 update documentation layout and theme
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I24c0d3f956602e6f67d1c0bfc68464cbb39eec0b
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-16 15:44:08 -04:00
Jenkins 4aa0d613e2 Merge "Usage: install cookiecutter firstly" 2017-05-26 14:21:10 +00:00
ChangBo Guo(gcb) 9fd9e035f0 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
2017-05-24 19:04:36 +08:00
ChangBo Guo(gcb) 99947bc697 Usage: install cookiecutter firstly
Change-Id: I8b651960a44a0ea962383cc8f0b31f12b4851bce
2017-05-23 11:21:53 +08:00