-
Notifications
You must be signed in to change notification settings - Fork 826
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
Setup of Sphinx for Docs #288
Comments
[springmeyer] not going to get to this anytime soon. pushing to 0.7.0 milestone |
[rweait] Well why don't I have a look at this? Shall we put in svn (I'll need access) or shall I drop it elsewhere for you to pull? |
[springmeyer] work started at: http://github.com/mapnik/sphinx-docs. marking against the sprint milestone so we can update the team and one in on next steps. |
[dodobas] I've started to work on Sphinx docs, there is a 'preview' available at http://open.geof.hr/~dodobas/mapnik-docs/ which is updated from time to time. I prefer to work on my own fork http://github.com/dodobas/sphinx-docs/, but I can push to main repository. There are some issues:
Any pointers would be helpful |
[springmeyer] Replying to [comment:5 dodobas]:
nice!
okay.
certainly. we as a community need to brainstorm about what is needed.
ya, boost is cool, but tricky. I need to work on boost bindings so that docstrings and argument hints are nicer. there may be no good solution but I've been meaning to look into it.
right, can you describe the problems? Any idea how to get them compatible? is sphinx looking for a method that is missing? based on http://bitbucket.org/birkenfeld/sphinx/issue/407/patch-do-not-inspect-boost-python-functions it appears we either need that patch or need to add func to boost python objects or maybe we need to patch boost python?
right, we want to match sure that our docstrings are ideally compatible with unittest too (which I know they are not right now but have not tried to look deeper).
We should have narrative docs in sphinx which are more important I think than autodoc which we can do separately with epydoc still if needed.
My thinking has been only trunk - so we can launch the docs with Mapnik2, but I'm open to suggestions.
yes. we should scope it! maybe we should have a skype documentation sprint sometime in october?
the only other thing is that we're thinking about developing a JSON reference of all symbolizer properties and using that to auto-build reST pages at some point soon... see: #626 and http://github.com/mapnik/Cascadenik/tree/jsonreference |
[mishok13] I have some experience with writing docs using sphinx, so some points:
|
[dodobas] Replying to [comment:6 springmeyer]:
is source:trunk/bindings/python something generated automatically, or manually so i can fiddle with it directly?
i've discovered this document,http://packages.python.org/an_example_pypi_project/sphinx.html#function-definitions, which explains these issues and demos different approaches using docstrings when integrating with sphinx. my point of view is that docstrings should be changed just enough to render better with sphinx and not break doc, i.e. use blank lines and text formatting (emphasis, bullets, etc.), http://is.gd/fANqy, last line ..Equality of coords... is rendered poorly without blankline after colon. Narrative docs are more important, but it would be nice to easily link them with library reference.
we can arrange it, on UTC time ofcourse :)
this could be very helpful, do it once and auto-build it later |
never got of the ground, now instead we have https://github.com/mapnik/mapnik-reference which is available through carto at https://www.mapbox.com/carto/ |
Its time for the Mapnik project to have awesome docs, easily maintainable and nicely presented.
We're limped along with docs on the Trac wiki for a while and we can now do better. We don't want to replace the trac wiki but we should expand on it systematically.
[http://sphinx.pocoo.org/ Sphinx] is an awesome documentation system for writing docs up, and I propose we use it to craft a new set of documentation for Mapnik2 and beyond.
The text was updated successfully, but these errors were encountered: