first pass at sphinx docs

[wraithan]

What it looks like on RTD:

http://readthedocs.org/docs/node-irc/en/latest/index.html
http://readthedocs.org/docs/node-irc/en/latest/API.html

RTD version is running against my repo against this branch. I put it up so you could see a rendered version of the docs in the theme that RTD uses by default. If/when you accept this pull request, I'll change the settings on the RTD project to point at your repo at the master branch. Once you've made an account on RTD I'll add you as an owner of the project and remove myself.

[wraithan]

Also, I'm not a great designer/docwriter/etc so restructuring would probably be advised to make it more readable but this is a start.

[martynsmith]

That all looks pretty good.

I just noticed though that if you view the API.rst in the docs/ folder via the github interface, then you don't actually get to see all the documentation?

Is that something we can fix before I merge it?

Everything else looks pretty awesome, and I'm inclined to change the README.rst at the root level to provide a link to RTD for people (i.e. coerce them in that direction)

That said, I'd still like to fix up people viewing in GitHub if we can?

[wraithan]

Github's rST implementation doesn't include the js domain stuff that sphinx has. Which gives you the nice bolding on the function name. It could be done differently but since RTD allows for versioned documentation you can have your tags up there as well as your dev docs making there be no need to view it directly on github.

[martynsmith]

Right, perhaps we just need to add a few links to the files then to make
sure users know that if they look in github they're going to be disappointed
;-)

On Sun, Oct 2, 2011 at 11:17 AM, Chris McDonald <
[email protected]>wrote:

Github's rST implementation doesn't include the js domain stuff that sphinx
has. Which gives you the nice bolding on the function name. It could be done
differently but since RTD allows for versioned documentation you can have
your tags up there as well as your dev docs making there be no need to view
it directly on github.

Reply to this email directly or view it on GitHub:
#35 (comment)

[wraithan]

Cool, my main intent was to get it 90% and convert all the current
docs over. From here it is probably best to have you merge it and add
the little tweaks like the links how/where you want them.

On Sat, Oct 1, 2011 at 4:16 PM, Martyn Smith
[email protected]
wrote:

Right, perhaps we just need to add a few links to the files then to make
sure users know that if they look in github they're going to be disappointed
;-)

On Sun, Oct 2, 2011 at 11:17 AM, Chris McDonald <
[email protected]>wrote:

Github's rST implementation doesn't include the js domain stuff that sphinx
has. Which gives you the nice bolding on the function name. It could be done
differently but since RTD allows for versioned documentation you can have
your tags up there as well as your dev docs making there be no need to view
it directly on github.

Reply to this email directly or view it on GitHub:
#35 (comment)

Reply to this email directly or view it on GitHub:
#35 (comment)

[wraithan]

Following up on this, if you need me to make those changes before you'll accept it, let me know. But I think you'll be better suited to put the links to where you want them on the appropriate pages.

[martynsmith]

Yeah, sorry,

My week really turned to custard fairly quickly :-(

I'm hoping I can find some more time this weekend to finish things off.

I merged a few of your patches, but I'll have to sort myself out a bit
before I finish merging this ;-)

It's definitely still on the top of my list though, just need to deal with
day-job issues first :-(

On Thu, Oct 6, 2011 at 3:10 PM, Chris McDonald <
[email protected]>wrote:

Following up on this, if you need me to make those changes before you'll
accept it, let me know. But I think you'll be better suited to put the links
to where you want them on the appropriate pages.

Reply to this email directly or view it on GitHub:
#35 (comment)

[wraithan]

No problem, just wanted to make sure there wasn't anything I needed to do. I try to make it a habit to follow up on my pull requests regularly in case it is something I forgot to do.

[martynsmith]

Okay, I believe this is now merged.

If you have a chance to look over things (or if there's anything I need to do at RTD can you please let me know :-)

Thanks,