RDFLib/rdflib — Issue #168: Get API docs online
Author: gjhiggins
Created: 2012-02-20 08:34:16+00:00
State: open

gromgull, 2011-08-20T10:23:19.000Z

Both current SVN state and for releases.

On the mailing list there has been talk of this several times.

Graham has this: http://bel-epa.com/rdflib3docs/

I do not know if it is kept up to date?

Eikeon said he can host it on rdflib.net

Or there is this: https://bitbucket.org/jezdez/sphinx-pypi-upload for uploading them to pypi.

Comment 1 by ed.summers
Might be fun to try to get them on ReadTheDocs http://readthedocs.org/

Comment 2 by gjhigg...@gmail.com
rdflib docs are already on RTD: http://readthedocs.org/docs/rdflib, they're re-built from the mercurial repos, so that will reflect any committed changes (not that there have been any).

I gathered up some preliminary docs which might provide a foundation for some rdfextras docs: http://readthedocs.org/docs/rdfextras (but I haven't had much opportunity to move on from there).

Might be an idea to park the epydoc-generated API docs on PyPi. I don't have the privs, tho'.

Comment 3 by ed.summers
Huh, I hadn't seen them there before neat :-) So what's the problem that this issue is trying to solve?

Comment 4 by gromgull
I hadn't seen it either - I guess the issue is trying to make my brain up to date with what exists :)

maybe we even link to the docs!

Comment 5 by ed.summers
+1 for linking to the docs on ReadTheDocs instead of rdflib.net

Comment 6 by gromgull
gjhiggins: Great stuff!

Where is the source for rdfextras doc? Maybe we could have docs folder for rdfextras as well? I keep meaning to document the lod endpoint web stuff I committed for instance...

I have linked to the docs from pypi and the front-pages of the google code projects - I cannot change rdflib.net

Ideally we would also have snapshots of the old docs for 2.4.2 etc, but I guess it never changed much :)

Comment 7 by gjhigg...@gmail.com
I'm a dreadful packrat for that kind of thing. The downloads section now offers a snapshot of the 2.5 svn version. I also took the opportunity to add a tarball of the epydoc API docs for rdflib 3.

Comment 8 by gjhigg...@gmail.com
I reckon this box is now ticked.