Re: [web2py] How to write documentation for REST API?

2015-09-16 Thread Richard Vézina 
Consider using other theme, I like abalaster (I think it the one used by
Flask, minimalist) : https://pypi.python.org/pypi/alabaster

I didn't see it but there is a bootstrap one too :
https://pypi.python.org/pypi/sphinx-bootstrap-theme/

Your project look nice... A lot of work...

:)

Richard

On Tue, Sep 15, 2015 at 4:11 PM, Michele Comitini <
michele.comit...@gmail.com> wrote:

> 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 :
>
>> 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 <
>> michele.comit...@gmail.com> 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 web2py+unsubscr...@googlegroups.com.
>>> 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 web2py+unsubscr...@googlegroups.com.
>> 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 web2py+unsubscr...@googlegroups.com.
> 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 web2py+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [web2py] How to write documentation for REST API?

2015-09-15 Thread Michele Comitini 
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 :

> 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 <
> michele.comit...@gmail.com> 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 web2py+unsubscr...@googlegroups.com.
>> 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 web2py+unsubscr...@googlegroups.com.
> 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 web2py+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [web2py] How to write documentation for REST API?

2015-09-14 Thread Richard Vézina 
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 <
michele.comit...@gmail.com> 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 web2py+unsubscr...@googlegroups.com.
> 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 web2py+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[web2py] How to write documentation for REST API?

2015-09-14 Thread Michele Comitini 
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 web2py+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.