[PATCH v2 0/6] Add some API documentation

Stephen Finucane stephen.finucane at intel.com
Tue Oct 13 05:54:33 AEDT 2015


Add some automatically generated documentation along with a small
HOWTO on XML-RPC (or, rather, patchwork's XML-RPC API) for new
developers. This will help lower the entry barrier for users who wish
to write their own scripts targetting the API.

---

v2:
- Add extensive documentation for the XML-RPC methods and serializers
  to make the autogenerated documentation more useful
- Some bug/typo fixes

Stephen Finucane (6):
  trivial: Clean up 'views/xmlrpc.py'
  views/xmlrpc: Add xmlrpc automatic documentation
  views/xmlrpc: Add documentation for API methods
  views/xmlrpc: Add serialization documentation
  views/xmlrpc: Remove unneeded '""' parameters
  docs: Add basic API guide

 docs/api.md                    |  51 +++
 patchwork/tests/test_xmlrpc.py |   2 +-
 patchwork/views/xmlrpc.py      | 691 ++++++++++++++++++++++++++++++-----------
 3 files changed, 563 insertions(+), 181 deletions(-)
 create mode 100644 docs/api.md

-- 
2.0.0



More information about the Patchwork mailing list