summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* We require the use of setuptools.Robert Collins2015-08-101-1/+1
| | | | | | distribute is long gone. Change-Id: Id8bf46d997327977e675f3c5e2988827e536d4fd
* Fix docs for environment markers in extras1.4.0Brant Knudson2015-07-301-3/+3
| | | | | | | | | | The docs for environment markers in setup.cfg [extras] had a couple of issues. 1) There was a space after the package name. 2) python_environment was used where python_version is the marker. Change-Id: Idbc72c45ae240356ca39eeba6db754f56c6a0f23
* Add more documentation around building docsMatt Riedemann2015-07-081-2/+23
| | | | | | | | | | | | | | | | | After digging in pbr and sphinx source code for a day to figure out what I was doing wrong, let's update the pbr docs with respect to building docs using the autodoc features in pbr. Specifically, document the autodoc_tree_excludes and warnerrors options and point out that you will probably need to set the exclude_patterns options in your sphinx config when excluding modules from the docs build and warnerrors=True. Also provide some links to the Sphinx docs for more details. Related-Bug: #1260495 Related-Bug: #1472276 Change-Id: Ib43830d08a156f37a3763ad2807d5c1f4cdbe3fe
* This documents the use of comments that work between 2.6, 2.7 and 3.4Sachi King2015-06-221-0/+16
| | | | | | | | | | Comments are not directly handled by PBR, this documents a reasonable working set of comments that can be used in setup.cfg. Comments are parsed out over three locations, configparser, which varies rather significantly between two and three, pkg_resources, and lastly when pip runs. Change-Id: Iedebc5baca4e21081708971540d6eab89e043f05
* Merge "builddoc: allow to use fnmatch-style exclusion for autodoc"1.1.0Jenkins2015-06-071-1/+2
|\
| * builddoc: allow to use fnmatch-style exclusion for autodocJulien Danjou2015-05-211-1/+2
| | | | | | | | | | | | | | This allows to use patterns such as heat.tests.* to exlude modules from autodoc genereation. Change-Id: Ibfc4161670fd9344da88c4a85a3aea992fcdf519
* | Merge "doc: add some basic doc about pbr doc options"Jenkins2015-06-071-0/+12
|\ \ | |/
| * doc: add some basic doc about pbr doc optionsJulien Danjou2015-05-211-0/+12
| | | | | | | | Change-Id: Iccb0ba35a008596cb63e1d6954bd9cb8fa50ae78
* | More explicit data_files install location docsJeremy Stanley2015-06-041-3/+6
| | | | | | | | | | | | | | | | Make it obvious to the reader that data_files installation target location translates to the actual system-wide root filesystem tree when installed with sufficient permissions to do so. Change-Id: I67a4dc61ab89b96b4f5e1f99f0199e5a3247412a
* | Add home-page into sample setup.cfgJames Polley2015-05-211-0/+1
|/ | | | Change-Id: I033cc482f441d59a193b4b1a87ddcbc96fd99885
* Merge "Teach pbr to read extras and env markers"1.0.0Jenkins2015-05-151-0/+39
|\
| * Teach pbr to read extras and env markersJames Polley2015-05-151-0/+39
| | | | | | | | | | | | | | | | | | This adds support for reading extras from setup.cfg. It also adds support for handling environment markers, both in the extras section and in install_requires and in requirements.txt. Change-Id: I6fd8276012e65f82934df9c374613b1ce6856b5a
* | Finish removing invocations of pip.Robert Collins2015-05-121-11/+13
|/ | | | | | | | We don't depend on recursive installations via pip - and pip certainly doesn't support that. We removed part of it recently, finish removing it all. Change-Id: I29bc4070b355e52124ceae459ea20403d134b60a
* Stop testing setup.py easy_install behaviourRobert Collins2015-04-291-0/+5
| | | | | | | | | Instead test pip install more thoroughly. Also document that we don't support setup.py install's easy-install behaviour. Change-Id: I87872a69425f9d4f17047e584c12516508d57b16
* Revert "Support platform-specific requirements files"lifeless2015-04-171-12/+2
| | | | | | | | | | This reverts commit 8cdb41cf1264e71fd2f479efa7decd38c1f91cfa. https://www.python.org/dev/peps/pep-0426/#environment-markers is the right approach for this, and as we haven't released master its safe to back this out. Change-Id: Ic7298fcbde54c6beda67c3c897efa75f1b60b78f
* Fixup semverRobert Collins2015-04-151-50/+51
| | | | | | | | | | | | | | | | The semver doc that Monty wrote was great, but doesn't work in the real world. Specifically because 1.dev1 < 1.a1, we're unable to depend on alphas without our testing getting locked down to the alpha on PyPI rather than the revision we're trying to test. This update fixes that by allowing 1.a1.dev1, audits for consistency with PEP-440, fixes up the contact details now that this is team maintained and notes that its as much Python specific as Linux specific. We also remove the never-in-a-release SemanticVersion.to_release method, as YAGNI. Change-Id: I005a2386842633e9fcda76adfc523196c8c2c95d Sem-Ver: feature
* Merge "Support platform-specific requirements files"Jenkins2014-12-041-2/+12
|\
| * Support platform-specific requirements filesClaudiu Popa2014-11-241-2/+12
| | | | | | | | | | | | | | | | | | | | This patch adds support for choosing a requirements file, based on the current OS, with the format 'requirements-{osname}'. This can be combined with the current approach of choosing a requirement file based on the Python version. The motivation for this is to replace conditional choosing of packages inside setup.py. Change-Id: I30c56082bb9b9bcd80128eedcef17b6beb793cf8
* | Packagers vs package maintainersThomas Goirand2014-12-021-12/+13
|/ | | | | | | The doc uses a familliar word of "packager", but the real name should be "package maintainer". This fixes it. Change-Id: Ieab50fe7ed0d666c9c6eff4c0b986765765f1ac4
* Clean up links and docsDoug Hellmann2014-10-082-0/+28
| | | | | | | | | | | | Move some developer information for running tests out of the README to the documentation. Change the home page link to point to the launchpad page. Add a link to the bug tracker to the README. Change-Id: I29bdb071eb64bccc561844c130a256b8f998da5f Closes-Bug: #1318548
* Stop using intersphinxAndreas Jaeger2014-09-131-4/+1
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Accept capitalized Sem-Ver headersJames E. Blair2014-09-031-2/+2
| | | | | | | | | | | In Git, HTTP, and SMTP, header names generally have the first letter of each word (including each part of a hyphenated word) capitalized. In all of the same cases, the actual headers are generally not considered case-sensitive. Accomodate this convention and the robustness principle by performing lower-case comparisons of header names, and using upper-case names in all of the documentation. Change-Id: Iffa68107c8ff2aeaac92434da85155213e45a3cd
* Look for and process sem-ver pseudo headers in gitRobert Collins2014-08-261-0/+10
| | | | | | | | | | | | | | | At the moment careful changelog review is needed by humans to determine the next version number. Semantic versioning means that all we need to know to get a reasonable default next version (and a lower bound on the next version) is a record of bugfix/deprecation/feature work and api-breaking commits. In this patch we start scanning for such headers from the git history to remove this burden from developers/project release managers. Higher versions can of course be used either via pre-versioning or by tagging the desired version. implements: blueprint pbr-semver sem-ver: feature Change-Id: Id5e8cd723d5186d1bd8c01599eae8933e6f7ea6d
* Raise an error if preversion versions are too lowRobert Collins2014-08-261-6/+16
| | | | | | | | | | | Right now the only automatic version number we have is 'last release', but thats enough for preversioning to be invalid. When we get API and ABI break support, this will do more useful things like telling us the next version is not sufficiently higher. implements: blueprint pbr-semver sem-ver: feature Change-Id: I2583c7409d51364ef9d84b39356d5608a95cb6f8
* Teach pbr about post versioned dev versions.Robert Collins2014-08-141-5/+11
| | | | | | | | | | | Untagged versions should not be presented as final versions, which is what was happening. The rules for dev versions are that they lead up to the next release, so to emit a dev version we have to increment the current version, then we can emit a dev version number. implements: blueprint pbr-semver sem-ver: feature Change-Id: Icf2f1999613e0d26424798697de34811b9cfc4ab
* Introduce a SemanticVersion objectRobert Collins2014-08-132-0/+19
| | | | | | | | | This object represents a single semver version and provides serialisation into different forms (dpkg/rpm/pep-440). implements: blueprint pbr-semver sem-ver: feature Change-Id: I482e07cce9b65df452d5b9af4c73960df68a141e
* Merge "Permit pre-release versions with git metadata"Jenkins2014-05-271-1/+1
|\
| * Permit pre-release versions with git metadataRobert Collins2014-05-271-1/+1
| | | | | | | | | | | | | | This is implied by the example and seems necessary for doing automated generation of pre-release versions. Change-Id: I8d4ceec200fac7982f2dafa7f8f1a8abfd4b0f83
* | Fix typos in docsRoger Luethi2014-05-212-5/+5
|/ | | | Change-Id: I547e99c24707895c1e3614821c5cb8da354b294a
* Documentation updatesVasudev Kamath2014-05-012-0/+27
| | | | | | | | | | * doc/source/index.rst: pbr requires git tags to be signed for using it to generate version information. Added a note mentioning this * doc/source/packagers.rst: documented SKIP_GENERATE_AUTHORS and SKIP_WRITE_GIT_CHANGELOG environment variable for packagers. Change-Id: I153c26f0d6876729dfb95eed2ab031c2aaa890d5 Signed-off-by: Vasudev Kamath <kamathvasudev@gmail.com>
* Fixed a typo in the documentation.Alex Gaynor2014-04-251-1/+1
| | | | | | Found using: https://github.com/intgr/topy Change-Id: I15d9469e60ea74aacba03b5ad0e50b4a87661892
* package: read a specific Python version requirement file0.6Julien Danjou2014-01-281-0/+15
| | | | | | | | | | This change makes pbr reads a specific requirement file tight to the major Python version that is used. So you can add a file such as requirements-py3.txt to have a specific requirement file for Python 3, or requirements-py2.txt to have a specific requirement file for Python 2. Change-Id: I4b548e9830586f11b82539d334dd5cf4b0445a36
* Fix typos in documentsChang Bo Guo2013-12-112-5/+5
| | | | | | | | | | Fix typos detected by toolkit misspellings. * pip install misspellings * git ls-files | grep -v locale | misspellings -f - Closes-Bug: #1257295 Change-Id: Ibb5917ab5af541a381630bd013b05d22badd4364
* Add the semver documentationMonty Taylor2013-10-092-2/+331
| | | | | | | This is a fork of the upstream semver documentation with an aim towards being a PEP440 compliant implementation of the ideas. Change-Id: I66a543fc08e0c1148a6db02dce207deabafed664
* Added documentation for packagersMonty Taylor2013-08-102-0/+67
| | | | | | | There are several features aimed at distro packagers that it's probably a good idea to tell them about. Change-Id: Ide4ec3b94c5da644c5a4d5eee6629f42f7b508ac
* Add support for globbing in data filesMonty Taylor2013-07-241-1/+7
| | | | | | | Similar to the work in the packages argument, allow the specification of a directory to recursively include as part of the install. Change-Id: Ife0414af468e7fcd4fc419eafc3e19e29efcfc7b
* Add more documentationMonty Taylor2013-07-211-3/+183
| | | | | | | | Moved a good portion of README into the sphinx docs. Also started fleshing out descriptions of how to use things. Also, fix the sphinx config. Change-Id: If53dcdaea0a48ef613e3097ab55d34f056160188
* python3: Use six everywhereChuck Short2013-06-021-4/+4
| | | | | | | Use six to improve compatibility between python2 and python3. Change-Id: Idc0b251d05f418a28a914d910dabd4a2d9ebdf2a Signed-off-by: Chuck Short <chuck.short@canonical.com>
* Cosmetic doc fixes.Monty Taylor2013-05-131-4/+4
| | | | | | | | | Change-Id: I753c663dbfeef0cfc94be8b146bad4170b0c0f89 Reviewed-on: https://review.openstack.org/28714 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Approved: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
* Align Sphinx autodoc options with oslo.Monty Taylor2013-04-061-9/+0
| | | | | | | | | | | The Sphinx autodoc changes also went into olso a little differently. Change-Id: If1f337db693053f2627c0c426a51bc13128033a7 Reviewed-on: https://review.openstack.org/25676 Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
* Rename back to PBR.Monty Taylor2013-03-172-5/+6
| | | | Change-Id: I13ee7fab7858231b0fa17f9116176a09184e8b0e
* Add docs dir.Monty Taylor2013-03-1213-0/+1309
Change-Id: I25e95a48a27b7e4151b09497adf02c7d5e328836
View Lorry Controller Status