summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge "Add doc/requirements"Zuul2022-10-261-0/+3
|\
| * Add doc/requirementsHervé Beraud2022-09-161-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We need to specify doc requirements in doc/requirements.txt to avoid problems with the pip resolver [1] for the release team [2][3]. Removing specific doc requirements from test-requirements.txt. The problem here is that this repos haven't doc/requirements.txt file and by default in this case zuul will use the test-requirements.txt file to pull requirements [4]. This requirements file contains extra requirements like flake8 that collided with those allowed in our job environment and so the new pip resolver fails to install these requirements and the job exits in error. This project meet the conditions leading to the bug. [1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html [2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html [3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html [4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36 Change-Id: I11c1f9816ad93f7c3a7d9de5894746d48154e18d
* | remove unicode prefix from codeniuke2022-09-161-7/+7
|/ | | | Change-Id: Ie842be912d9169133cd9990846f212bb50690766
* Correct a typo in the documentzhaoleilc2020-07-101-1/+1
| | | | | | | This patch changes 'contex' to 'context' in doc/source/specification/resources.rst Change-Id: I8c56dfa869cbc1176b18de76212c143b161a3d5b
* Switch to newer openstackdocstheme version3.1.0Andreas Jaeger2020-05-301-4/+4
| | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 version. Using this version will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. 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: I6c6775f75235dab2b9ed7820bfc5102bf5b04965
* Bump the openstackdocstheme extension to 1.20ussuri-em3.0.0pengyuesheng2020-02-101-26/+0
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: Ibc5757b36d6a5b8c342d959087136064ed5ab6f5
* Drop python 2.7 support and testingpengyuesheng2020-02-031-3/+9
| | | | | | | | | | | | | | | | | | Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Include small cleanups: * remove install_command from tox.ini, this is the default * Use sphinx-build as modern way to run sphinx, remove setup.cfg settings for build-sphinx * Use sphinxcontrib-apidoc for docs with newer sphinx * Remove obsolete doc/source/conf.py broken * Add python-requires to setup.cfg to make Python 3.6 requirement explicit * Remove obsolete pbr setup-hooks Co-Authored-By: Andreas Jaeger <aj@suse.com> Change-Id: Iec8c47b82022b616b8361651bf23f853b0ce5624
* Removes temporary fix for doc generationColleen Murphy2019-07-053-46/+1
| | | | | | | | | | | | | | | | A temporary fix was added to get around a bug in how pbr handles its autodoc_tree_index_modules setting. Since this bug is fixed we no longer need the work around. This change is needed since the workaround is now incompatible with the latest version of Sphinx. See also[1][2]. [1] https://review.opendev.org/191633 [2] https://review.opendev.org/121667 Change-Id: Idf9dc73d99b4233f49effe24aa047959b1a2ef2c
* Trivial: Update pypi url to new urlmelissaml2018-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: Idf7bf448a1066d343c8db95e94c01310d943c6ad
* Merge "Turn on warning-is-error for sphinx build"Jenkins2017-07-171-8/+8
|\
| * Turn on warning-is-error for sphinx buildSamriddhi Jain2017-07-171-8/+8
| | | | | | | | | | | | | | | | | | | | | | | | The doc-migration spec requires all projects to treat warnings as errors during sphinx build. This patches turns that function on and resolves the error (detailed below) coming as a result of it. The code block in event_concept.rst file is currently made to render in javascript which is an incorrect syntax for it. Change-Id: Id7fee247b76ed7cfebb849305e0611bc966709be
* | Merge "Switch from oslosphinx to openstackdocstheme"Jenkins2017-07-171-1/+8
|\ \
| * | Switch from oslosphinx to openstackdocsthemeSamriddhi Jain2017-07-171-1/+8
| |/ | | | | | | | | | | | | Following the new doc migration spec, the documentation theme needs to be switched to openstackdocstheme. Change-Id: Ia840524a4c3b4ceb9605c997a2971d84880c70ac
* | Update URL in docs as per the doc-migration specSamriddhi Jain2017-07-142-3/+3
|/ | | | | | | The migration spec has listed some changes in the URLs of project directories. This commit fixes those changed URLs. Change-Id: Id040fdf9cc16cd6b05c82cc93e88301f743a1801
* Use https for *.openstack.org referencesEric Brown2017-02-053-5/+5
| | | | | | | The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: Ib2dce89ac43e844a5f1b3adcfe9bcaf4141043ce
* Remove unused pngmath Sphinx extensionAndreas Jaeger2016-02-291-1/+0
| | | | | | | | There's no RST file that uses ".. math" and thus the pngmath Sphinx extension is not used and can get removed. Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
* Adding ironic api specific audit map configurationLokesh S2016-02-061-1/+3
| | | | | | Closes-Bug: 1541232 Change-Id: Ic267cd171564240363b39b288dd6c22f7851f4fb
* Enable cadf support for HeatRakesh H S2016-01-211-0/+2
| | | | | | | Adds heat_api_audit_map.conf to enable cadf support for Heat. Closes-Bug: #1536483 Change-Id: Ic3e68748ab5440d2d21554b6cdf0d793fdbf38a9
* make generate_uuid return valid uuidgordon chung2015-11-122-14/+14
| | | | | | | | | | | | original design prepended a namespace to the beginning of uuid. this scoped the uuid to a namespace but it is technically invalid. this patch drops the behaviour of prepending string. rather, it takes the namespace, hashes it, and uses uuid v5 to generate valid uuid based on that namespace Change-Id: Ibde222c91522fa3c4a1720b6a8da81dac31560b9 Closes-Bug: #1504889
* Include changelog/history in docsJoshua Harlow2015-09-243-221/+9
| | | | | | Removes old manually generated file. Change-Id: I4e50fb2ccbc665f8cc16b7fc575422ce959a0058
* Merge "Fix event example"Jenkins2015-09-241-1/+2
|\
| * Fix event exampleStanisław Pitucha2015-09-241-1/+2
| | | | | | | | | | | | Even example had two lines merged together. Change-Id: If3a40b5512630ca79e3880f8bee5b34950bdcbec
* | Event doc indentation issueStanisław Pitucha2015-09-231-2/+2
|/ | | | Change-Id: I705391d800e104381758b6c5b54e5d124b32e1e5
* Fixed typo errorJUNJIE NAN2015-08-181-1/+2
| | | | | | Before action there should be a "," there. Change-Id: I29f690e0e42b1b1bfccf19e5ea576974f105e826
* Merge "Remove empty _templates folder"Jenkins2015-03-122-1/+1
|\
| * Remove empty _templates folderSteve Martinelli2015-03-122-1/+1
| | | | | | | | | | | | as far as i can tell, this folder does nothing Change-Id: I4f2c6c56a87d62665b45b40b1a8769149fbfd469
* | Add a section for audit mapsSteve Martinelli2015-03-112-0/+43
| | | | | | | | | | | | | | the docs had no reference to the audit mapping files that pycadf provides. Change-Id: I18aeac07735211acb3dcf0044321b9a6cb9c1040
* | Merge "add a new set of release notes"Jenkins2015-03-111-2/+24
|\ \
| * | add a new set of release notesSteve Martinelli2015-03-071-2/+24
| |/ | | | | | | | | | | | | adds a date for 0.7.0 release notes, and adds info about releases 0.7.1 and 0.8.0. Change-Id: I7450c44a453936467b6d55b52c81c11eb81d9cce
* | Merge "Fix formatting error for geolocation note"Jenkins2015-03-111-6/+5
|\ \
| * | Fix formatting error for geolocation noteSteve Martinelli2015-03-071-6/+5
| |/ | | | | | | | | | | | | The section was more of a `note` than an `example`, and renders more clearly when the rst `note` tag is used. Change-Id: I7b7c92301ce2bcfa60b44a0297eeb3848d89355e
* | Clean up pycadf's doc landing pageSteve Martinelli2015-03-073-79/+19
|/ | | | | | | | | | | | | | - the end of the intro paragraph came to an unexpected stop, so clean that up. - suggest removing the debugging section, as that is now maintained by oslotest: http://docs.openstack.org/developer/oslotest/features.html - add more info to the contributing section, since it was lacking before. Change-Id: I7abd5b0ce192f18fa80a208ac5b191d1c7bd2981
* Additional doc clean upSteve Martinelli2015-02-1911-248/+307
| | | | | | | | | | 1) Added code-block headers to the JSON examples 2) Formatted the JSON examples 3) Replaced a few instances of double-byte characters with more their usual counter parts ("-" and "'"), these normally originate from the openstack wiki for some reason. Change-Id: I2ca1dbfc5bdf1c50da466b290a6460a42f1b885a
* cleanup documentationgordon chung2015-02-164-91/+16
| | | | | | | | | | - fix image width to conform to formatting - move specification out of dev section - redirect middleware doc to keystonemiddleware - add full spec pdf link to specifications page - drop tree depth so we don't have 'serialisation' subheaders in toc Change-Id: Ia36c029b792f574b2b30623b3b2696242b79d75c
* Fix oslo.messaging link in docslin-hua-cheng2015-02-041-1/+1
| | | | Change-Id: I508cef2cc49e3324ed44ab1f1024bc8fd01646a3
* Add release notesSteve Martinelli2014-10-292-0/+199
| | | | | Change-Id: Id4b274f27ad06f91a06587157ed5da064c93873e Closes-Bug: #1336976
* Stop using intersphinxDavanum Srinivas2014-09-291-1/+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: I6d0bb0678ff35a751c0b7c40cb73803701eb8a75 Related-Bug: #1368910
* Debug env for toxBrad Topol2014-07-282-0/+36
| | | | | | | | | | | | | | | | | | Running a test with pdb was difficult because tox captures output and causes pdb prompt to quit. Tips for how to run with debug are provided here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests This change puts these commands into a debug env in tox.ini so you can do a command like tox -e debug pycadf.tests.test_cadf_spec and when it hits your breakpoint you'll get the debug prompt. Change-Id: I53893d618cd60c0456368088497542db7e4a6eac Co-Authored-By: Brant Knudson <bknudson@us.ibm.com>
* Fix a grammatical error in contributing docBrad Topol2014-07-231-1/+1
| | | | | | | I noticed a small grammatical error in the contributing doc so I went ahead and fixed it. Change-Id: Idb36271fa37f7e970e4d2698f9817cbdd63f0269
* Expand © and remove unnecessary encoding linesMartin Geisler2014-06-151-1/+0
| | | | | | | | | | | | | | | | | | The word "Copyright" alone is sufficient to claim copyright, the © symbol need not be present.[1] This allows us to expand the "©" symbol into "(c)" to avoid introducing non-ASCII characters. As per PEP 263, a Python file with non-ASCII characters must have a line with "coding: <some-encoding>". Python files containing only 7-bit ASCII characters need no such line.[2] This commit expands the non-ASCII Unicode copyright symbols and removes the now unnecessary encoding lines. [1]: http://www.copyright.gov/circs/circ03.pdf [2]: http://legacy.python.org/dev/peps/pep-0263/ Change-Id: Ibbb282224bccbea383947b4e09a619f94d5c24b1
* reorder documentationGordon Chung2014-04-106-23/+98
| | | | | | | - reorder documentation so it's grouped logically. - add api docstring modules Change-Id: I47e49634fe7d8bb16a51f3045e7fe53683d56d1a
* add OpenStack Foundation as authorGordon Chung2014-03-171-4/+4
| | | | | | add OpenStack Foundation as author Change-Id: Iac1b743fa4c0d0ead2badaee5f36451e91465bf0
* pycadf documentationGordon Chung2014-03-1727-0/+1627
add basic documentation on CADF spec. Closes-Bug: #1279951 Change-Id: Ie1703d9b5109d8275377857e5362e3b09385f647 Implements: blueprint document-pycadf
View Lorry Controller Status