search

mapnik / mapnik.github.com

mapnik.org
8 stars 13 forks source link

Update Python API docs #24

Open springmeyer opened 9 years ago

springmeyer commented 9 years ago

Once Mapnik 3.0.0 is released we should:

/cc @flippmoke who I'm sure has been thinking about this. Also /cc @danpat who mentioned he'd be interested in tackling this.

danpat commented 9 years ago

I did a quick conversion to using Sphinx: http://danpat.net/mapnik-python-3.0.0rc2/ using the readthedocs theme. It's fairly pretty, and this seems to be the popular way to document python stuff currently. I have not worked on TOC generation, and there are quite a few formatting issues.

One obvious shortcoming is the lack of docs for the Symbolizers. Should we be attempting to integrate mapnik-reference into these binding docs as well?

springmeyer commented 9 years ago

seems to be the popular way to document python stuff currently.

Nice, looks great. Note: I'm okay with these looking different than the node.js docs.

One obvious shortcoming is the lack of docs for the Symbolizers.

Yes, and moreover the API is partially broken currently: https://github.com/mapnik/python-mapnik/issues/7. See below for what I think is the best solution for styling docs

Should we be attempting to integrate mapnik-reference into these binding docs as well?

Yes, I think we should integrate mapnik-reference to mapnik.org: See #25