In the end I used sphinx with this extension:

http://pythonhosted.org/sphinxcontrib-httpdomain



2015-09-15 3:56 GMT+02:00 Richard Vézina <[email protected]>:

> I like the way it's done here : https://open.fda.gov/api/reference
>
> I had saw many API doc that were looking the same (just can found back a
> couple of example). I thought at first that it was made using sphinx but
> can't found any trace of it in the souce of the page or on the github of
> the open fda projects... There is a mention of pygments on the github, so
> maybe it only using pygments for syntax higligths...
>
> It may be less heavy then sphinx to put in place...
>
> Richard
>
> On Mon, Sep 14, 2015 at 3:57 AM, Michele Comitini <
> [email protected]> wrote:
>
>> What is a good way to document a small REST API (@request.restful)?
>> sphinx?
>>
>> Suggestions welcome!
>>
>> mic
>>
>> --
>> Resources:
>> - http://web2py.com
>> - http://web2py.com/book (Documentation)
>> - http://github.com/web2py/web2py (Source code)
>> - https://code.google.com/p/web2py/issues/list (Report Issues)
>> ---
>> You received this message because you are subscribed to the Google Groups
>> "web2py-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to [email protected].
>> For more options, visit https://groups.google.com/d/optout.
>>
>
> --
> Resources:
> - http://web2py.com
> - http://web2py.com/book (Documentation)
> - http://github.com/web2py/web2py (Source code)
> - https://code.google.com/p/web2py/issues/list (Report Issues)
> ---
> You received this message because you are subscribed to the Google Groups
> "web2py-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> For more options, visit https://groups.google.com/d/optout.
>

-- 
Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
--- 
You received this message because you are subscribed to the Google Groups 
"web2py-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to