Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Python API docs #24

Open
springmeyer opened this issue Jun 11, 2015 · 2 comments
Open

Update Python API docs #24

springmeyer opened this issue Jun 11, 2015 · 2 comments
Milestone

Comments

@springmeyer
Copy link
Member

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.

@springmeyer springmeyer added this to the Phase 2 milestone Jun 11, 2015
@springmeyer springmeyer mentioned this issue Jun 11, 2015
3 tasks
@danpat
Copy link

danpat commented Jun 11, 2015

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
Copy link
Member Author

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: mapnik/python-mapnik#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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants