Gabriel Gellner wrote:
> Well seeing the need I am writing up a tutorial for simple compilation and
> usage for my Sphinx docs. This leads me to update some of the other pages
> to
> reflect recent changes, and I would like some feedback to ensure I
> understand
> everything!

Note that I wrote some paragraphs on simple compilation etc. in my NumPy
tutorial (wiki.cython.org/tutorials/numpy).

Question: Can I as a Cython developer modify these docs?

For instance, take the compilerdirectives docs currently at

http://wiki.cython.org/enhancements/compilerdirectives

where should I have added this? Similar for documenting the behaviour at
http://wiki.cython.org/enhancements/buffer.

Ideally I'd like either a) a "docs" subdirectory in the Cython repository,
or b) a wiki-like interface to the official docs. (Is there a Sphinx
plugin to MoinMoin perhaps?)

a) has the advantage that it is simple and means that documentation is
versioned together with the sources which has many advantages (easy to
check whether the "with" statement was supported in version X). A single
commit that adds a feature would then change the docs as well.

(At least last time I checked, the docs weren't in the repo...)

> * CEP 106 (Package pxds): should I update the wiki (and add to the docs)
> that we have a bunch
>            of basic .pxd's now? Or are we waiting for something?

Sounds good.

> * CEP 302 (with statement): again status is DONE, again seems to work for
> me,
>     but the wiki still says this is a limitation, is there a go ahead to
>     remove this from the limitation wiki?

This is OK now, go.

BTW, great that you are doing this, documentation has a way of falling
behind...

Dag Sverre

_______________________________________________
Cython-dev mailing list
[email protected]
http://codespeak.net/mailman/listinfo/cython-dev

Reply via email to