summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Clarify the need for setup.py with PEP517Clark Boylan2021-11-081-2/+9
| | | | | | | | | | | | | There was a misunderstanding that PBRs PEP517 build hooks meant we no longer needed a setup.py. But it turns out the setuptools build_meta hooks that we wrap call out to setup.py. This means PBR will continue to need to be used in conjunction with a setup.py. This is better for backward compatibiltiy anyway so not a huge loss. Document this more properly and update the test to reflect it. Change-Id: If4320da1e89a5c765e0bfe56b724364f9cba34f3
* Add a PEP517 interface5.7.0Monty Taylor2021-11-031-0/+12
| | | | | | | | | | | | | | | | | | | | | | pep517 defines a new module method of specifying build backends. To allow pbr to exist in this world, we should define the interface that's needed. For this to be used, one will put: [build-system] requires = ["pbr>=5.7.0", "setuptools>=36.6.0", "wheel"] build-backend = "pbr.build" Into pyproject.toml - and the pep517 interface will be used. This doesn't really change anything else - it just makes us support this. So by itself this commit isn't SUPER helpful. But maybe let's take baby steps with something this prone to strife, yeah? After this we can start teasing some things apart and doing our own things directly. Co-Authored-By: Clark Boylan <clark.boylan@gmail.com> Change-Id: I293f59b5074a38c78adffe580de2f1533bb01ce7
* Dropping lower constraints testingHervé Beraud2021-03-091-0/+1
| | | | | | | | | | | | | | | | | We facing errors related to the new pip resolver, this topic was discussed on the ML and QA team proposed to to test lower-constraints [1]. I propose to drop this test because the complexity and recurring pain needed to maintain that now exceeds the benefits provided by this mechanismes. Replace assertTrue by assertIn to fix with the latest flake8 version. Add six in the documentation requirements to fix the build. Fix the conflict status with hacking. [1] http://lists.openstack.org/pipermail/openstack-discuss/2020-December/019390.html Change-Id: I580da15fefd6ad352e69749b77cc4664aef84f9c
* Adding pre-commitHervé Beraud2020-10-211-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduced changes: - pre-commit config and rules - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks. - Applying fixes for pre-commit compliance in all code. Also commit hash will be used instead of version tags in pre-commit to prevend arbitrary code from running in developer's machines. pre-commit will be used to: - trailing whitespace; - Replaces or checks mixed line ending (mixed-line-ending); - Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker); - Checks that non-binary executables have a proper shebang (check-executables-have-shebangs); - Check for files that contain merge conflict strings (check-merge-conflict); - Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements); - Attempts to load all yaml files to verify syntax (check-yaml); - Run flake8 checks (flake8) (local) For further details about tests please refer to: https://github.com/pre-commit/pre-commit-hooks Change-Id: I730018e2bf788be5ac4e993af1746296206edfc1 Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Merge "Add Release Notes to documentation"Zuul2020-08-272-0/+7
|\
| * Add Release Notes to documentationJeremy Stanley2020-08-112-0/+7
| | | | | | | | | | | | | | | | We're building the sdist to be able to add PBR's changelog in its docs, so may as well publish the Release Notes document it builds too. Change-Id: Icd1b4ae04de8034bc15db87be457751e70e26f6d
* | Merge "Re-add ChangeLog"Zuul2020-08-062-0/+2
|\ \ | |/
| * Re-add ChangeLogJeremy Stanley2020-08-062-0/+2
| | | | | | | | | | | | | | | | One of PBR's features is ChangeLog generation, so it only makes sense that we would include PBR's ChangeLog in published documentation too. (Also publishing a ChangeLog is helpful.) Change-Id: Ie1561c0852dfc6731c29e9202f74f0e4c4b08786
* | Merge "Update some url to use opendev.org"Zuul2020-08-061-1/+1
|\ \ | |/
| * Update some url to use opendev.orgAntoine Musso2020-08-061-1/+1
| | | | | | | | | | | | | | | | | | The git web URL is now: https://opendev.org/openstack/pbr Also stop linking README.rst to no more existing history/changelog documentation page (removed by 96b84a90141). Change-Id: I56b0e2b86a7fc66c5ae25e06175033a885f500f6
* | Support newer openstackdocsthemeAndreas Jaeger2020-08-061-1/+8
|/ | | | | | | | | | | | openstackdocstheme 2.2.0 introduces new variables, add them here so that both older and newer openstackdocstheme versions are supported. 2.2.0 suport the old settings but in the future those might get removed, so let's be future-proof. Since this repo is still supporting py27, we need support for older openstackdocstheme versions. Change-Id: I6ee389843d1d959cffb126e0cd56ef6ef1e2f5e1
* Stop using pbr sphinx integrationBen Nemec2019-06-075-9/+11
| | | | | | | Switch to sphinx-build directly and add sphinxcontrib-apidoc for generated api docs. Change-Id: I089a7695986892dcb47c5b5e79a6a227891a2347
* Update Sphinx requirementHervé Beraud2019-05-161-1/+2
| | | | | | | Sphinx 2.0 no longer works on python 2.7, so we need to start capping it there. Change-Id: Ia13b8a75f11ee997e00e817464829ce8b86d2e16
* Typo fix: s/extract_mesages/extract_messages/Ben Nemec2019-03-251-1/+1
| | | | Change-Id: If4141dd8e8876fc3d9d3e7579177a44f7c7da563
* Change openstack-dev to openstack-discussmelissaml2019-02-151-1/+1
| | | | | | Mailinglists have been updated. Openstack-discuss replaces openstack-dev. Change-Id: Ifc72c767e76283df4608da8d7097ef86c367a5cf
* Merge "Add an option to skip generating RELEASENOTES.rst"5.1.0Zuul2018-10-162-0/+25
|\
| * Add an option to skip generating RELEASENOTES.rstTim Burke2018-09-242-0/+25
| | | | | | | | | | | | | | | | This is comparable to the existing skip_authors and skip_changelog options. Change-Id: Icfefb20fb3c9b2e983e56f6e5440119d4dce2d3f Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
* | Merge "packaging: Remove support for pyN requirement files"Zuul2018-10-062-11/+11
|\ \
| * | packaging: Remove support for pyN requirement filesStephen Finucane2018-07-232-11/+11
| | | | | | | | | | | | | | | Change-Id: I7f915ecdc819bc4d3c6811949f12bdadb108a1ab Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "docs: Add docs for reno integration"Zuul2018-10-062-1/+17
|\ \ \ | | |/ | |/|
| * | docs: Add docs for reno integrationStephen Finucane2018-09-242-1/+17
| |/ | | | | | | | | Change-Id: I9a77a4f6397464c33181d8b4bd2a9ae79c058b47 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Special case long_description_content_typeIan Wienand2018-10-051-0/+4
| | | | | | | | | | | | | | | | As described in the pypa pull request, special-case passing through these fields into the metadata. setuptools will maintain them. Change-Id: I89eb8c6d627790680a61a0a4b7490191b6e8e90c Closes-Bug: #1762494
* | Fix typo in contribution instructions.Moises Guimaraes de Medeiros2018-09-101-1/+1
|/ | | | | Change-Id: Ia514b4baf3f5079547d7c198eac60cab96ba3a0e Signed-off-by: Moises Guimaraes de Medeiros <moguimar@redhat.com>
* Deprecate 'build_sphinx' integrationStephen Finucane2018-07-182-0/+60
| | | | | | | | We now have a path away from this feature, so let's deprecate it while we can. Change-Id: Idfc34b9085c6da9b8cac24986be5f3bad142d927 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Add Sphinx extensionStephen Finucane2018-07-182-0/+35
| | | | | | | | This duplicates what already exists in openstackdocstheme but provides a migration path for users outside of the OpenStack ecosystem. Change-Id: I73750b3fe984f9d2f339aac0f435a83ee68c89da Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* doc: Add documentation for missing '[pbr]' optionsStephen Finucane2018-07-182-7/+27
| | | | | | | | There are more that just autodoc options in here. Some formatting issues are also corrected. Change-Id: I075281d97c2fc7981a38ff1ddbb4ec76717ac726 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* doc: Fix formatting of packagers guideStephen Finucane2018-07-181-38/+41
| | | | | | | We're going to be making some changes to this shortly. Change-Id: I07e8421dd8b6598da75348e3d8d3baae3ae457ff Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Switch to stestrStephen Finucane2018-07-181-0/+3
| | | | | | | | | | | | | | According to Openstack summit session [1], stestr is maintained project to which all Openstack projects should migrate. Let's switch to stestr as other projects have already moved to it. While we're at it, we also fix the docs requirements and removed the unused 'pypy' and 'cover' tox targets. [1] https://etherpad.openstack.org/p/YVR-python-pti Change-Id: I424068adc9092be2cf40d117c9dc4e92bb51e804 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Add leading 0 on alpha release in semver docGaetan Semet2018-05-241-11/+16
| | | | | Change-Id: I3c13be99237ff8840f36e21cae684d346defc03d Signed-off-by: Gaetan Semet <gaetan@xeberon.net>
* Explicitly read setup.cfg as utf-8 on Python 3Ben Nemec2018-03-271-0/+5
| | | | | | | | | | Per the referenced bug, relying on the terminal encoding to read setup.cfg is not safe. Unfortunately, Python 2 doesn't accept an encoding when reading config files so we need a fallback path for that version. Change-Id: If49344db2f9139c0557f6acd17671163e02468a5 Closes-Bug: 1745396
* Make docs on env vars a little clearerClark Boylan2018-03-201-4/+4
| | | | | | | | | | It was pointed out that the packager docs don't make it super obvious that the env var settings that packagers can set are env vars. Add export statements to the docs to imply it a bit more that we are talking about env vars here. Change-Id: I9e9eefa661994237a63b59dcefab11961ef339e1 Fixes-bug: 1724425
* Merge "doc: Minor rework of usage doc"Zuul2018-01-092-167/+166
|\
| * doc: Minor rework of usage docStephen Finucane2018-01-082-167/+166
| | | | | | | | | | | | | | | | Reorder some section to highlight those that are totally unique to pbr rather than simply modified. Change-Id: I8cea0ae7d85409573dc6cf1a5d2b7a8ebc5fe8b8 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "doc: Rework features doc"Zuul2018-01-093-87/+271
|\ \ | |/
| * doc: Rework features docStephen Finucane2018-01-083-87/+271
| | | | | | | | | | | | | | Break this document into sections and expand upon some of these. Change-Id: Ia6a3eed984ce4257cce9df0997e6be2d8d3bc683 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Support PEP 345 Project-URL metadata"Zuul2018-01-081-0/+4
|\ \ | |/ |/|
| * Support PEP 345 Project-URL metadataJeremy Stanley2017-11-221-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | By including one or more Project-URL entries in PKG-INFO metadata, PyPI can display helpful hyperlinks in a generic manner. Add support here to be able to pass it through setup.cfg with a project_urls dict. See the corresponding section of the Core Metadata Specifications from the Python Packaging User Guide for details: https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use Setuptools implementation is underway here: https://github.com/pypa/setuptools/pull/1210 Change-Id: I14e580c654b619cab7eb24e31f736056d6cf9bd4
* | Support v<semver> versionGaetan Semet2018-01-051-0/+6
| | | | | | | | | | | | | | Allow protect tag (in gitlab, github) using "v*" regex. Change-Id: I3e6eb1031ae92349c5a9531b143b6470482664e7 Signed-off-by: Gaetan Semet <gaetan@xeberon.net>
* | Support Description-Content-Type metadataJeremy Stanley2017-12-041-1/+2
|/ | | | | | | | | | | | As of setuptools 36.4.0, support for Description-Content-Type metadata was added via the long_description_content_type variable. Add a metadata.description-content-type option for setup.cfg so it can be provided through PBR. This makes it possible to instruct PyPI and potentially other frontends to know an explicit RFC 1341 content type, along with character set and variant, for the accompanying long description. Change-Id: I852f603d9ca4e4cd469eab4cae9933ef2581e3af
* Deprecate support for Sphinx < 1.6Stephen Finucane2017-09-251-8/+9
| | | | | | | | | | | | | | | | We don't want to support older versions of Sphinx forever. While OpenStack's global requirements have been bumped to Sphinx 1.6, there are non-OpenStack users in the wild. Give them a chance to upgrade to the newer version before we completely remove support. This also gives us a chance to deprecate the '[sphinx_build] builders' setuptools option, which is no longer necessary with Sphinx 1.6+. Do this. The documentation is updated to reflect this (and some references to a "custom" 'source_dir' option removed, as it's not at all specific to pbr). Change-Id: I18bbf693bca2f6e49d822ae2940d2170a2b90ce9 Related-Bug: #1702872
* switch from oslosphinx to openstackdocsthemeDoug Hellmann2017-06-262-8/+15
| | | | | | Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb Change-Id: I58acb2cc35d33af586201a4667d82388a51987d5 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* turn on warning-as-error flag for doc buildDoug Hellmann2017-06-223-25/+34
| | | | | Change-Id: I5566cfa09dac8dec7a1bc32d95b42d5b136d726f Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* rearrange existing documentation using the new standard layoutDoug Hellmann2017-06-2210-510/+541
| | | | | | Change-Id: I885f1adf4fbfc1137c6c48039096bd7bdf89cbd3 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* docs: Don't specify pbr version in 'setup.py'Stephen Finucane2017-06-201-1/+1
| | | | | | This is no longer the recommended practice. Change-Id: Id61de0873e1599f7b5b6c63536266adb89c1fc3c
* allow user to override the output location of api docs3.1.0Doug Hellmann2017-06-151-0/+11
| | | | | | | | | Allow the user to specify 'api_doc_dir' in the build_sphinx section of their setup.cfg to control where the auto-generated API documentation is written. Change-Id: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Merge "Make oslosphinx optional"Jenkins2017-04-271-2/+8
|\
| * Make oslosphinx optionalThomas Bechtold2017-03-091-2/+8
| | | | | | | | | | | | | | Avoid cyclic dependencies between pbr and oslosphinx. So if oslosphinx is not available, continue to be able to generate the documentation. Change-Id: I4c1f8ea5cded268388dab29931055223f8999c8a
* | Stop building man pages by defaultStephen Finucane2017-04-141-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | From pretty much the beginning [1], pbr has defaulted to building both man page and html output, but has failed to document it anywhere. People tend to copy-paste their 'setup.py' and 'conf.py', or rely on the 'cookiecutter' project, with very little understanding of what's going on under the hood (and why would you care - it's docs :)). This means that the vast majority of folks using 'pbr' (basically everyone in OpenStack) have been unwittingly building "man pages" as part of their doc builds for no good reason, which has also led to a lot of confusion when this magic behavior is the cause of bugs [2][3]. There's no good reason that pbr should default to building both man pages and html output. For folks that want this functionality, we should document it so they can use it. For everyone else though, let's do the sane thing and output html like the standard 'build_sphinx' plugin. [1] https://github.com/openstack-dev/pbr/commit/5b8b7f1d [2] https://bugs.launchpad.net/pbr/+bug/1681983 [3] https://bugs.launchpad.net/oslotest/+bug/1379998 Change-Id: I579134a2b7980669180c1666503b848835cc2957 Closes-Bug: #1681983
* | docs: Use definition listsStephen Finucane2017-04-141-51/+70
| | | | | | | | | | | | These are far more concise and easier to read. Change-Id: I411685b6e7d5385386b40cbf4b8bd4445b3c6847
* | Merge "doc: Document Sphinx integration"Jenkins2017-04-141-6/+60
|\ \
View Lorry Controller Status