Timothy Corbett-Clark avatar Timothy Corbett-Clark committed cfca1e4 Draft

Edited online

Comments (0)

Files changed (1)

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//.
 
-TODO:
+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.
+
+== References ==
 
 * [[http://packages.python.org/an_example_pypi_project/sphinx.html]]
-* [[http://packages.python.org/sphinxcontrib-httpdomain/]] (includes Flask extension)
-* [[http://read-the-docs.readthedocs.org/en/latest/getting_started.html]]
-* Seriously consider converting this wiki into Sphinx and have it picked up by Read The Docs.
-** Perhaps try using [[http://johnmacfarlane.net/pandoc/]]
+* [[http://read-the-docs.readthedocs.org/en/latest/getting_started.html]]
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.