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
Too aggressive trimming caused lines and indents to go lost.
This patch makes docs whitespace just right (TM).
Change-Id: If10bc6cb10c8cd26bb7ea7a071d9f0e4f34235b5
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
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
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
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
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
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
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>
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 the python 3 version with the latest stable. Remove the python 2
version. The support of this version is soon finish.
Change-Id: Id80849594d43977a5e058f2b88ef3b6ddda5d072
This commit updates some URLs. All of our docs.openstack.org supports
HTTPS already. And, some of the URLs are outdated.
Change-Id: I49056e5bd196e5cca2faaa8f5bc34b56c89ff675
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
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
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
- 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
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
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
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>
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
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