summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* remove unicode from codewangjiaqi072022-08-251-6/+6
| | | | Change-Id: Ib4c9f766b2844d8a3cdc748fbd9ef98b81aec5a5
* Merge "Adding pre-commit"Zuul2020-10-054-180/+59
|\
| * Adding pre-commitHervé Beraud2020-09-154-180/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: I045fa1cd7932d960e1cf49b2c335c7acdeba0b46 Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* | fix supported python versions in documentationvictoria-em3.2.2Evgeni Golov2020-09-081-1/+1
|/ | | | Change-Id: Ia92d5b8f6194d9f7ba2f3221fe378dafe23be567
* switch to importlib.metadata packageDoug Hellmann2020-07-065-5/+7
| | | | | | | | | | | | | | | | Load entry points using 'importlib.metadata' instead of 'pkg_resources'. Include a caching layer. The cache stores the parsed text data from all of the ini input files in a single JSON file with a name based on the hash of the path entries and the mtimes. This should produce a unique filename for each import path, regardless of the use of a virtualenv. The data is stored in a format that means no other files need to be examined or parsed in order to return EntryPoint objects. Change-Id: I8b08f289d446f4775eac1e1a91997fa96f25f641 Depends-On: Ic6db7af34c87a636bfe55bacae03c42154f4b9c7 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Merge "Stop to use the __future__ module."2.0.0Zuul2020-06-031-2/+2
|\
| * Stop to use the __future__ module.Hervé Beraud2020-06-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The __future__ module [1] was used in this context to ensure compatibility between python 2 and python 3. We previously dropped the support of python 2.7 [2] and now we only support python 3 so we don't need to continue to use this module and the imports listed below. Imports commonly used and their related PEPs: - `division` is related to PEP 238 [3] - `print_function` is related to PEP 3105 [4] - `unicode_literals` is related to PEP 3112 [5] - `with_statement` is related to PEP 343 [6] - `absolute_import` is related to PEP 328 [7] [1] https://docs.python.org/3/library/__future__.html [2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html [3] https://www.python.org/dev/peps/pep-0238 [4] https://www.python.org/dev/peps/pep-3105 [5] https://www.python.org/dev/peps/pep-3112 [6] https://www.python.org/dev/peps/pep-0343 [7] https://www.python.org/dev/peps/pep-0328 Change-Id: I5f8107287877dc5dc4a12c1f85e8671c8d49f56f
* | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-06-021-20/+5
|/ | | | | | | | | | | | | | | | | | | | | | | | | 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: Ie53af423c56f3355e7e911e6f2efd6c73c6d57c5
* update git.openstack.org to opendevliuwei2019-04-251-1/+1
| | | | Change-Id: Ie3617d76b6131386c2fa241b41888436ed44909f
* Update doc/conf.py to avoid warnings with sphinx 1.8zhang.lei2018-09-181-1/+1
| | | | | | | | The autodoc_default_flags option is now deprecated.[1] This warning can cause documentation build failed. use autodoc_default_options instead. [1]https://github.com/matplotlib/matplotlib/pull/11928 Change-Id: I73041da072edb635661503b75a9c7460e1242220
* fix tox python3 overridesDoug Hellmann2018-06-061-1/+1
| | | | | | | | | | | | | | | | | We want to default to running all tox environments under python 3, so set the basepython value in each environment. We do not want to specify a minor version number, because we do not want to have to update the file every time we upgrade python. We do not want to set the override once in testenv, because that breaks the more specific versions used in default environments like py35 and py36. Decode subprocess output so it has the right type under python 3. Change-Id: Id2df5439fa6e788199bec4ac7c98c56347053621 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Trivial: Update pypi url to new urlXiaojueGuan2018-05-011-2/+2
| | | | Change-Id: Ie738ac6938b035c414c0c8d964b771c5155ed115
* Trivial: Update pypi url to new urlmalei2018-04-211-1/+1
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: Ifc9114fd4b4d95f2ae0acd7e0a19d217786b1168
* Make openstackdocstheme an optional doc dependencyThomas Bechtold2017-08-231-2/+14
| | | | | | | | | stevedore is a library that is used outside of OpenStack, too. Having a build requirement that needs something OpenStack specific makes life in cases (eg. for downstream packagers) more difficult. So let's make openstackdocstheme an optional requirement. Change-Id: Ic8cc577e617e5da699f9dc43830183005bd2ee66
* switch from oslosphinx to openstackdocstheme1.24.0Doug Hellmann2017-06-281-1/+8
| | | | | Change-Id: I1416bd7e05901dc22f0915af32808ff41ffbb2d0 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* move documentation into the new standard layoutDoug Hellmann2017-06-2824-36/+43
| | | | | Change-Id: Id5ae008eab8e52d8943659b809ed1bcd996e0794 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Broken link at stevedore developer documentation1.19.1Marianne Linhares2016-12-041-1/+1
| | | | | | | | At http://docs.openstack.org/developer/stevedore/ the link about "setuptools entry points" is broken. Change-Id: I7cfd5af64e83b75f83c6ac0d48bfff2eac3c7435 Closes-bug: #1647151
* Remove reference to non-existing pageAndreas Jaeger2016-10-291-1/+0
| | | | | | There is no modindex page generated, remove reference to it. Change-Id: I2707c653ab4c7ab6b13478c5c0da35b82f0b5f65
* Remove irrelated output itemChangBo Guo(gcb)2016-07-041-1/+0
| | | | | | | We register two entry points in sample code, but show three items in entry_points.txt, just remove it to keep consistent with code. Change-Id: I7a76c4f23086fe1abdbf7140ba92f97ec1387aed
* dont claim copyright for future years1.13.0Bernhard M. Wiedemann2016-03-091-1/+1
| | | | | | | | otherwise, when building from unchanged source in 2018, it would claim Copyright 2018, Dreamhost which is not true Change-Id: I5185828a965467ea04033e46a1af2435df4ad760
* Add a reference to entry_point_inspector1.12.0Marc Koderer2016-02-231-0/+6
| | | | | | | This add a short reference in the install guide to the entry_point_inspector. Change-Id: I86f3437949670e75f631319e088321384fe28e42
* Clean up Python 2.6 related stuffChangBo Guo(gcb)2015-11-261-1/+1
| | | | Change-Id: I303465277b30dff66129b6c65112b3e427ee6292
* Merge "replace the hard-coded history list with an auto-generated one"Jenkins2015-09-252-116/+6
|\
| * replace the hard-coded history list with an auto-generated oneDoug Hellmann2015-09-242-116/+6
| | | | | | | | | | | | | | | | | | | | | | Replace the hand curated list of changes with the one generated by pbr automatically. At the same time, change the toctree settings in index.rst to avoid showing every release of stevedore at the top level and to clean up the amount of nesting showing for other entries. Change-Id: I3fb9306c0ca3ce6ed9681ffeaa8b9b8ed0f2bd7c
* | Add clarifying language to description of scanning for pluginsDoug Hellmann2015-09-241-1/+2
| | | | | | | | | | | | | | | | | | Clarify that the python import path is scanned to find packages and their metadata is examined, so that it is clear that the packages must be installed in a way that makes them both visible to the same python interpreter. Change-Id: I0fc58b3ccc024e209d7f49de7402de67d4437295
* | Show how to add a plugin in a separate packageDoug Hellmann2015-09-241-13/+48
|/ | | | | | | | | | | | | One of the most common misconceptions about plugins is that they must be installed to the same python package as the application. Update the documentation to provide an explicit example of providing plugins from a separate package. Also clean up the package metadata for the existing example to remove references to URLs and email addresses that no longer work. Change-Id: I801b6ec3ff287c5342ce63a865167f55d31c78d3 Closes-Bug: #1394393
* Fix spelling typo for maunalZhao Lei2015-09-241-1/+1
| | | | | | | | | | occuring -> occurring for patterns_loading.rst Plus some source comment spelling fix. Change-Id: Ia6c79588e70a4150fdcb8e71d14a4bba47a70a23 Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
* Removed non-free color profile from .jpg1.5.0Thomas Goirand2015-05-317-0/+0
| | | | | | | | | | | | | | | All the .jpg files in doc/source/essays had this embedded: "Copyright 2007 Apple Inc., all rights reserved." This is an ICC color profile which is copyrighted by Apple and which is non-free, and may trigger some warnings/errors by the distribution linters. This patch converts the .jpg into the sRGB color space. I did this simply loading the images in GIMP, and exporting again after accepting the auto-coversion to sRGB. Change-Id: Ibfdf0828ff149d5c83eb864c4fb854e80868a613
* Merge "Add sphinx integration"Jenkins2015-05-283-0/+75
|\
| * Add sphinx integrationDoug Hellmann2015-05-273-0/+75
| | | | | | | | | | | | | | Add a restructuredtext directive for documenting a set of plugins with the needed hooks to make it available is sphinx. Change-Id: I1a24f9326b4e54174d9dc0ae366315fe29c3ac1b
* | Fix Python versions supportedDavanum Srinivas2015-05-131-1/+1
|/ | | | | | | | | | | We have CI for 2.6, 2.7, 3.4. So make sure all references to other versions are removed and all 3 versions above are correctly mentioned where required. Make sure we specify 3.4 everywhere needed Change-Id: I2c90bccfc7495bf8197319196a12b2a8bd0519f1
* Bring doc build up to standardDoug Hellmann2014-10-2722-0/+1570
Move the requirements definitions and documentation files to the standard places used by other OpenStack projects so our doc publishing jobs will work. Change-Id: Iea630d827976fe517afacf4e373b3a125efff9c9
View Lorry Controller Status