RPTools.net

Discussion and Support

Skip to content

It is currently Sun Dec 10, 2017 11:13 pm 






Reply to topic  [ 3 posts ] 

Previous topic | Next topic 

  Print view

Author Message
User avatar  Offline
Cave Troll
 
Joined: Mon May 17, 2010 9:04 pm
Posts: 38
 Post subject: Hosted Java Docs
PostPosted: Mon Nov 09, 2015 9:03 am 
I've used http://readthedocs.org before with my Python projects to host the dev documentation. It's nice looking and you can set it up to rebuild the docs whenever the Git repo updates. It's really nice feature however is the versioned documents. So if you release v2, you still have a great, accurate place for version 1's documentation.

Is there any desire for something like this? Is there anything like that for JavaDocs? I believe we could get Sphinx working with the project, but I don't think that's the prefered solution. I'd be willing to do the work getting everything setup, but wanted to gauge interest first.


Top
 Profile  
 
 Offline
Great Wyrm
 
Joined: Sun Jun 22, 2008 6:53 pm
Posts: 2102
Location: Melbourne, Australia
 Post subject: Re: Hosted Java Docs
PostPosted: Mon Nov 30, 2015 6:07 pm 
Something like this would be nice, but one of the problems is the JavaDoc in the source code might be a little lacking... A few of us have started to address this when adding/modifying stuff, but the phrase a drop in the ocean comes to mind.


Top
 Profile  
 
 Offline
Cave Troll
 
Joined: Sun Mar 01, 2015 12:57 am
Posts: 70
 Post subject: Re: Hosted Java Docs
PostPosted: Sat Mar 04, 2017 4:33 pm 
I mean, honestly, if you really want good documentation it should be provided by the developer on the source control itself, or at least at a high-level in terms of org charts etc...there's not a lot of benefit readthedocs can do here...

Don't get me wrong that's nice for python documentation, but its basically the output of a process that doesn't exist in rptools. If there was documentation, then there would be the ability to auto-magically generate this documentation and stick it inside a doc jar, which could then be processed however (either into your IDE, or into a server somewhere, like readthedocs).


Top
 Profile  
 
Display posts from previous:  Sort by  
Reply to topic  [ 3 posts ] 

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:

Who is online

In total there is 1 user online :: 0 registered, 0 hidden and 1 guest (based on users active over the past 5 minutes)
Most users ever online was 243 on Sun Nov 04, 2012 6:14 am

Users browsing this forum: No registered users and 1 guest





cron

Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group

Style based on Andreas08 by Andreas Viklund

Style by Elizabeth Shulman