[Yt-dev] yt-2.0 documentation uploaded

[Matthew Turk]

(Just to yt-dev)

These new docs are in advance of the release, which will be 2.0.  But
one thing that I am trying to do is decouple the documentation from
the releases, which (inasmuch as they matter at all) happen very
seldom.  So the docs_html.zip file is no longer in the main
repository, and the builds can happen any time.  This means, for
instance, when new docstrings are added!

I'd like to open this up for comments -- what do you all think of the
new organization of the documentation?  The orientation section is
new, the separation of concepts is new, and I think overall it fits
better with how I personally think about yt.  But what do *you* all
think?

Additionally, the docs are currently at
http://hg.enzotools.org/yt-doc/  .  You should be able to build them
at home, if you have numpydoc installed, but I'm going to modify the
numpydoc extension source code (to match what we want from it) and
include it in the repository.  Please feel free to edit, modify, add
content, and let me know if you don't have push privs and would like
them.

Thanks a bunch,

Matt

On Fri, Jan 14, 2011 at 5:58 PM, Matthew Turk <matthewturk at gmail.com> wrote:
> Hi everyone,
>
> I've uploaded a preliminary build of the new documentation for yt-2.0 here:
>
> http://yt.enzotools.org/doc/
> (downloadable: http://yt.enzotools.org/doc/download.zip )
>
> yt 2.0 will be released Monday.
>
> Please let me know any comments or suggestions you might have about
> the documentation -- if you see any problems, or any areas you think
> could use more information, or more emphasis, you'd like to help, etc
> etc, please feel encouraged to drop me a line.  In particular, the
> orientation section is brand new, and the documentation on the whole
> has been reorganized.
>
> Best wishes,
>
> Matt
>