[yt-dev] 3.0 Documentation

Matthew Turk matthewturk at gmail.com
Fri Dec 13 05:42:10 PST 2013


Hi Cameron,

Thanks for taking this on!  I think that we should definitely push up
some 3.0 docs (which it sounds like Kacper is working on) but I'm not
sure that we should link them *until* they are mostly up to date.
Fortunately the cookbook process and the IPython Notebook process
won't pass until they are, so that's good.

Once the AGORA telecon is over today I should be able to spend some
time hitting the easy changes to the docs that should bring them
mostly up to speed.  One thing we'll need to do with 3.0 that we
haven't in the past is emphasize much more strongly the developer
aspects, as some areas of the code -- while cleaner -- are different
in some key ways.

-MAtt

On Thu, Dec 12, 2013 at 6:34 PM, Cameron Hummels <chummels at gmail.com> wrote:
> Hello everyone,
>
> Now that the bulk of the development is moving over to the yt-3.0 branch, I
> propose we have the yt-3.0 docs available on the website.  Right now, a
> yt-3.0 branch exists in the yt-doc repository, but there are very minor
> changes in it relative to the yt 2.x documentation.  Unfortunately, there is
> no public way to view these documentations aside from downloading the
> repository and building locally.  I think by putting the 3.0 docs on the
> webpage, it will make it more likely that people contribute docs when they
> contribute new code changes, whereas if we wait too long, the codebase may
> get considerably out of sync with the docs.
>
> I think this will only require a slight change to the buildbot targets by
> Kacper.  What do people think?
>
> Cameron
>
>
> --
> Cameron Hummels
> Postdoctoral Researcher
> Steward Observatory
> University of Arizona
> http://chummels.org
>
> _______________________________________________
> yt-dev mailing list
> yt-dev at lists.spacepope.org
> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>



More information about the yt-dev mailing list