895836149f
Retire stackforge/sphinxcontrib-docbookrestapi
2015-10-17 16:04:50 -04:00
c2470abd86
Bump to 0.2.1
...
Change-Id: Idd32f8a5dda490cf501b721cacb249d8ebc2f717
2014-05-05 16:43:48 +02:00
c1bbf72f7c
add venv to tox.ini
...
Change-Id: I4e4959dd3c0d808deaea3ab45a31af73d97f40c7
2014-05-05 07:15:28 -07:00
5f419178f8
Bump to 0.2
...
Change-Id: Iae3b7fa88f91b6a0133f09c8447e00c3247a5dca
2014-05-05 14:41:38 +02:00
774201c5db
Add the Python 3 classifiers in setup.cfg
...
Change-Id: I95d4170b30a6e658e8a7fcf9c83f33152424b986
2014-05-05 14:15:03 +02:00
b076c0368a
Merge "Sync with global requirements"
2014-05-04 23:07:45 +00:00
fbf0740685
Declare sphinxcontrib.docbookrestapi package
...
Change-Id: If494b57f73ad70e8b66e5dd41689c6d688cb18e6
2014-03-31 16:04:03 +02:00
e57ae0157b
Properly declare namespace package
...
The 'sphinxcontrib' is declared a namespace package by setuptools means
via pbr. Setuptools 0.7 or later mandates explicit declaration via
pkg_resources.declare_namespace (PEP-382).
Otherwise refuses to "setup.py build" on systems with setuptools>0.7.
Change-Id: If0d214a3b2d148450faa2b09292aafcdcf6837e9
2014-03-31 15:40:44 +02:00
9218f010a9
Properly document the enumeration type
...
Change-Id: I5ace904a43fb8d429c8ea212a80ef81e3b13ee84
2014-02-10 14:46:36 +01:00
0f0a56f768
Allow foo_name as well as foo_id in paths
...
Ceilometer has recently replaced 'meter_id' by 'meter_name', so 'foo_name'
should be allowed.
Change-Id: I702346935919d7f0df49c20cc14cfcbc6e85a17b
2014-02-06 21:16:12 +01:00
5506c9ad69
Remove 'xmlns' attribute of 'param' elements
...
Change-Id: I385e463df15146af925c476b2f552d7a9b7b294c
2014-02-05 21:38:09 +01:00
8587f3c4bc
Use 'para' elements instead of 'p' ones
...
Also, remove the xmlns attribute.
Change-Id: I57645305df749f44378cf093ba5b5dcf8a096ae7
2014-02-05 16:28:03 +01:00
a622c84b3d
Add the top-level comment that is now mandatory in WADL files
...
Change-Id: I8d24e5184403958d393f5d69bab06c485519b214
2014-02-03 17:47:57 +01:00
471dc8c3b4
Add an XML declaration in the output
...
Change-Id: I2e828cf7635f976244d30c9cc9013a997b9d7967
2014-02-01 02:36:50 +01:00
d1d4e62736
Use 'wadl:doc' instead of 'doc' and fix its attributes
...
Use the right values for the 'xmlns' and 'xml:lang'.
Change-Id: I3315553afd2c0f3683815f0ea89e10769d06485b
2014-01-30 22:19:35 +01:00
9caebf8371
Add a mandatory 'id' attribute to 'resource' elements
...
This is now required by api-site.
Change-Id: Ifdfd80060cb294ded92c99743c371ae22df933b7
2014-01-30 16:19:45 +01:00
607177b8b4
Removes whitespaces at the end of self-closing tags
...
Tidy automatically adds one (see line 1347 at
http://tidy.cvs.sourceforge.net/viewvc/tidy/tidy/src/pprint.c?revision=1.119&view=markup ),
but api-site does not want them.
Change-Id: Ibcd1dcfd18f673af3fb7e45fb746ee0466487072
2014-01-30 14:35:53 +01:00
7f81b6f459
Sync with global requirements
...
Change-Id: Iec9dac0464918ef53099001933be3ab10d76170b
2014-01-16 09:23:53 +01:00
a4f650e15a
Add tests
...
This adds a test for the 'generate_id' method, and all the configuration needed
to run tests.
Change-Id: Iaf8158da1f96853f3880f1b8e6ade5d466e27c64
2014-01-15 20:44:45 +01:00
8b44f51c01
Python 3 compatibility
...
Use pytidylib6 instead of pytidylib to be able to support both Python 2 and 3.
Change-Id: Iaad55f5603496272a8aa9066e0b0fb1268038162
2013-12-10 18:09:19 +01:00
9ad4e8f5fe
Fix the code to work with Python2.6
...
It was previously using some features introduced in Python2.7.
Change-Id: I3b4b2895f231cf98235efd16f65eb123db8a9157
2013-11-29 18:50:42 +01:00
7266f9e7db
tox.ini: clean the pep8 target
...
There were some leftovers from the tox.ini from Ceilometer, which was used in
the beginning.
Change-Id: I16cef6dd65e449b029590f7da36c4462860dada8
2013-11-28 14:23:20 +01:00
ee217854eb
Allow complex types for parameters
...
Tools like Ceilometer need to have "Alarm" as a type, instead of something as
simple as "string" or "int".
Change-Id: I16af1e077ee4641f52a2607f6269e1dd633b4b54
2013-11-18 14:17:48 +01:00
220cd4907d
Merge "Fix the generate_id function with PUT methods"
2013-11-15 19:26:59 +00:00
fae50a8471
Fix the generate_id function with PUT methods
...
Now handle methods such as /v2/alarms/alarm_id/state.
Change-Id: I15cdc6a65f38fee7e4ad6559741144fdf43eb1f6
2013-11-15 20:24:01 +01:00
e1d097d915
Add .gitreview file
...
Change-Id: I054681c9c23747827a5b1708e7ddd37f1d12266b
2013-11-15 20:08:28 +01:00
819e98a84e
Wrap lines in the generated WADL file
2013-10-16 20:28:16 +00:00
16c1a9c062
Generated human-readable method ids and titles
2013-10-16 20:27:55 +00:00
86a69a01c0
Use '<para role="shortdoc">...</para>'
...
Inside the 'wadl:doc', this is what should be used to write the description of
the method, instead of a simple 'p' element.
2013-10-10 10:56:46 +00:00
8698122d4f
Make the 'wadl:doc' element appear first
...
Inside 'method' elements, the 'wadl:doc' element should appear before the
'request' and 'response' elements.
2013-10-10 10:52:50 +00:00
0b6dce2be7
Fix PEP8-related warnings
...
Add a tox.ini (mostly stolen from ceilometer), so that one can run 'tox
-epep8'.
2013-10-07 13:23:01 +00:00
1f88543554
Remove the version hack in setup.py
2013-10-07 12:16:32 +00:00
7d446b37a3
Indent the generated WADL file
...
Also, remove the lxml import that was never needed.
2013-10-07 12:00:17 +00:00
552b8c9404
Only parse the intended files
...
Files meant to be parsed by sphinxcontrib-docbookrestapi should now have a
comment that reads 'docbookrestapi' before the first section of the RST,
otherwise they'll be ignored.
2013-10-07 10:36:09 +00:00
3753d6bfde
Move code to sphinxcontrib/docbookrestapi.
2013-10-01 13:53:03 +00:00
3a7d797679
MyNodeVisitor: call SparseNodeVisitor.__init__()
2013-09-27 13:22:04 +00:00
79720726fd
sphinxcontrib/setup.py: Add license header.
2013-09-27 12:12:33 +00:00
3111e93bee
Add missing shebangs.
2013-09-27 12:12:09 +00:00
2df0486705
Initial commit.
2013-09-26 14:59:01 +00:00
Monty Taylor