walidazizi / rdflib

Automatically exported from code.google.com/p/rdflib
Other
0 stars 0 forks source link

Get API docs online #182

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
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.

Original issue reported on code.google.com by gromgull on 20 Aug 2011 at 10:23

GoogleCodeExporter commented 8 years ago
Might be fun to try to get them on ReadTheDocs http://readthedocs.org/

Original comment by ed.summers on 20 Aug 2011 at 5:07

GoogleCodeExporter commented 8 years ago
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'.

Original comment by gjhigg...@gmail.com on 24 Aug 2011 at 2:10

GoogleCodeExporter commented 8 years ago
Huh, I hadn't seen them there before neat :-) So what's the problem that this 
issue is trying to solve?

Original comment by ed.summers on 24 Aug 2011 at 10:17

GoogleCodeExporter commented 8 years ago
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! 

Original comment by gromgull on 24 Aug 2011 at 11:03

GoogleCodeExporter commented 8 years ago
+1 for linking to the docs on ReadTheDocs instead of rdflib.net

Original comment by ed.summers on 24 Aug 2011 at 11:32

GoogleCodeExporter commented 8 years ago
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 :)

Original comment by gromgull on 26 Aug 2011 at 7:28

GoogleCodeExporter commented 8 years ago
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.

Original comment by gjhigg...@gmail.com on 17 Sep 2011 at 1:31

GoogleCodeExporter commented 8 years ago
I reckon this box is now ticked.

Original comment by gjhigg...@gmail.com on 17 Sep 2011 at 1:32