1. Timothy Corbett-Clark
  2. rest-api-blueprint

Commits

Timothy Corbett-Clark  committed cfca1e4 Draft

Edited online

  • Participants
  • Parent commits 0ebf76c
  • Branches default

Comments (0)

Files changed (1)

File ApiDocumentation.wiki

View file
 
 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]]