[Ns-developers] ns-3 manual format

[Gustavo Carneiro]

On Tue, Dec 21, 2010 at 20:00, Bryan Ward <bryan at bryanward.org> wrote:

> Ok, I've got a draft of the manual built with sphinx.  I haven't done much
> more than a cursory glance to ensure the output looks ok, but it all builds
> without errors or warnings. I tried to translate as literally as possible
> straight from the existing manual. You can check it out through these
> links:
>
> html:
> http://www.eg.bucknell.edu/~bcw006/ns3manual/
>
> pdf:
> http://www.eg.bucknell.edu/~bcw006/ns-3.pdf
>
> source:
> http://www.eg.bucknell.edu/~bcw006/sphinx-manual.tar.gz
>
> I'm open to any feedback anyone has on this before I move on to the
> tutorial. One thing in particular: Mathieu, in the stuff you gave me to
> begin with, it looked like you were changing the structure of the document
> a
> bit with the "core" section and "nodes and net devices" section. If you
> want
> to continue with this I think we'll need to reorganize a few things, but
> that's a pretty trivial change.
>

It looks very very good, both PDF and HTML versions.  Thank you for doing
this, Mathieu, Brian, and Tom.

I like Sphinx a lot, especially the way there's a builtin javascript search
function.  Also that it is easy and obvious how to make links anchored to
individual sections.

-- 
Gustavo J. A. M. Carneiro
INESC Porto, UTM, WiN, http://win.inescporto.pt/gjc
"The universe is always one step beyond logic." -- Frank Herbert