Commits

Timothy Corbett-Clark  committed d237bbd Draft

Edited online

  • Participants
  • Parent commits b2f5469

Comments (0)

Files changed (1)

File ApiDocumentation.wiki

 
 The last bullet in particular suggests using [[http://sphinx.pocoo.org/|Sphinx]], the de facto choice and tool behind [[http://readthedocs.org]] and [[http://packages.python.org]] //etc//.
 
-I tried using the [[http://packages.python.org/sphinxcontrib-httpdomain|httdomain sphinx extension]] (which includes Flask extension), but did not find it sufficiently expressive. Preferred instead to keep more flexibility.
+I tried using the [[http://packages.python.org/sphinxcontrib-httpdomain|httdomain sphinx extension]] (which includes Flask extension), but did not find it sufficiently expressive. Preferred instead to keep more flexibility.
+
+== Approach ==
+
+* Write reST in separate files, tell Sphinx about them, compile into Flask's {{{static/}}}, and redirect HTTP GET for {{{text/html}}} to the appropriate page.
+* When compiling the docs, the examples are created by running against the real server, ensuring that they are correct.
+
+See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs|apidocs]] for