Timothy Corbett-Clark avatar Timothy Corbett-Clark committed 35c9d78 Draft

Edited online

Comments (0)

Files changed (1)

ApiDocumentation.wiki

 
 * Write reST in separate files
 * Tell Sphinx to compile them into Flask's {{{static}}} folder.
-** Run [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/make_apidocs.sh|make_apidocs.sh]]
-** The examples are generated using the [[http://packages.python.org/sphinxcontrib-programoutput|programoutput]] extension to run against the server, thus automatically ensuring accuracy. Beware that the extension caches outputs...
+* Run [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/make_apidocs.sh|make_apidocs.sh]] to convert the reST into HTML.
+ ** The examples are generated using the [[http://packages.python.org/sphinxcontrib-programoutput|programoutput]] extension to run against the server, thus automatically ensuring accuracy. Beware that the extension caches outputs...
 * Redirect HTTP GET for {{{text/html}}} to the appropriate page
 
-See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs|apidocs]] for details. Beware that Bitbucket does not understand all the Sphinx directives so it is best to browse the {{{.rst}}} files in raw mode (or just download the repo and view locally).
+See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/restapiblueprint/apidocs|apidocs]] for details. Beware that Bitbucket does not understand all the Sphinx directives so it is best to browse the {{{.rst}}} files in raw mode (or just download the repo and view locally).
 
 == See also ==
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.