summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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