librelist archives

« back to archive

Make the documentation for a new extension ?

Make the documentation for a new extension ?

From:
Stephane Wirtel
Date:
2011-02-23 @ 03:36
Hi all,

I just created a new extension for Flask, but I want to add a documentation.
Where can I find the default layout and the stylesheets and how to generate it ?

http://bitbucket.org/matrixise/flask-openerp

Regards,

Stéphane

Re: [flask] Make the documentation for a new extension ?

From:
Simon Sapin
Date:
2011-02-23 @ 04:25
Le 23/02/2011 12:36, Stephane Wirtel a écrit :
> Hi all,
>
> I just created a new extension for Flask, but I want to add a documentation.
> Where can I find the default layout and the stylesheets and how to generate it ?
>
> http://bitbucket.org/matrixise/flask-openerp

Hi,

You can run the Flask extension wizard and copy the docs directory. 
After that it’s standard Sphinx.
https://github.com/mitsuhiko/flask-extension-wizard

If you’re using git be careful that the wizard uses a git submodule to 
get the Flask theme for the docs.

Regards,
-- 
Simon Sapin
http://exyr.org

Re: [flask] Make the documentation for a new extension ?

From:
Stephane Wirtel
Date:
2011-02-23 @ 11:09
thanks I will check with this code.

And for the qualification of my extension ? I think there is a procedure.

Regards
On 02/23/2011 05:25 AM, Simon Sapin wrote:
> Le 23/02/2011 12:36, Stephane Wirtel a écrit :
>> Hi all,
>>
>> I just created a new extension for Flask, but I want to add a documentation.
>> Where can I find the default layout and the stylesheets and how to 
generate it ?
>>
>> http://bitbucket.org/matrixise/flask-openerp
> 
> Hi,
> 
> You can run the Flask extension wizard and copy the docs directory. 
> After that it’s standard Sphinx.
> https://github.com/mitsuhiko/flask-extension-wizard
> 
> If you’re using git be careful that the wizard uses a git submodule to 
> get the Flask theme for the docs.
> 
> Regards,

Re: [flask] Make the documentation for a new extension ?

From:
Julen Ruiz Aizpuru
Date:
2011-02-23 @ 11:56
az., 2011.eko otsren 23a 12:09(e)an, Stephane Wirtel(e)k idatzi zuen:
> thanks I will check with this code.
>
> And for the qualification of my extension ? I think there is a procedure.
>

Have you read through the docs?
http://flask.pocoo.org/docs/extensiondev/#approved-extensions

j.