Commits

Timothy Corbett-Clark committed 509d7f6 Draft

Edited online

  • Participants
  • Parent commits 0038c07

Comments (0)

Files changed (1)

File ApiDocumentation.wiki

 == Approach ==
 
 * Write reST in separate files
-* Tell Sphinx to compile them into Flask's {{{static/}}}
-** Create the examples by running against the real server, thus automatically ensure accuracy
+* Tell Sphinx to compile them into Flask's {{{static}}} folder.
+** Run [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs/make.sh|make.sh]]
+** The examples are generated by running against the real server, thus automatically ensure accuracy
 * Redirect HTTP GET for {{{text/html}}} to the appropriate page
 
 See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs|apidocs]] for details.