<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Fri, Jan 24, 2014 at 11:59 AM, Matthew Turk <span dir="ltr"><<a href="mailto:matthewturk@gmail.com" target="_blank">matthewturk@gmail.com</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On Fri, Jan 24, 2014 at 2:57 PM, Cameron Hummels <<a href="mailto:chummels@gmail.com">chummels@gmail.com</a>> wrote:<br>


> I'm generally in favor of this, as it will lower the barrier to writing<br>
> documentation, but I have a few questions.<br>
><br>
> 1) Dependencies.  Right now, there is a non-trivial amount of work required<br>
> to build the docs in full (or even in part).  It isn't a matter of just<br>
> going into docs and typing `make html` with a vanilla yt installation.  If<br>
> you want to build all of the notebooks, you need extra libraries, some of<br>
> them taking a decent amount of time to install.  Pandocs installation is<br>
> somewhat tricky (homebrew it isn't bad, but with macports, it is very<br>
> problematic), and I recall a lot of extra steps.  Anyway, if we're going to<br>
> package the docs with code, should we include all of the docs dependencies<br>
> in the yt installer?  Or just leave it to individuals to do this on their<br>
> own?<br>
<br>
</div>Leave it to individuals, and make it a safe failure if the deps aren't there.<br>
<br>
I mean, if we're relying on notebooks, the failsafe for not being able<br>
to turn them into docs is ... to run them in the notebook.  Right?<br></blockquote><div><br></div><div>We could also make the the lightweight ReadTheDocs buiild the default option.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">


<div class="im"><br>
><br>
> 2) By my count, yt-docs (unbuilt) takes 41MB of space, with yt-hg taking<br>
> 113MB of space, so I think this is not going to break the bank to move the<br>
> docs into the yt repo, as long as we continue to do mostly dynamically<br>
> generated images/movies/content.  If we start tracking lots of media files,<br>
> it could bulk pretty fast.<br>
<br>
</div>I agree, and I am very nervous about that.  When you say it takes 41MB<br>
of space, are you counting the .hg directory?<br>
<div class="im"><br>
><br>
> 3) What happens to the history of the docs in mercurial if we move them into<br>
> the yt source repo?  Does it start everything at ground zero?  Or do we<br>
> retain the history of commits from the yt-doc repo?<br>
<br>
</div>My proposal was to simply import them en masse without retaining the<br>
history, but not to delete the old repository.<br>
<div class="HOEnZb"><div class="h5"><br>
><br>
> Cameron<br>
><br>
><br>
> On Fri, Jan 24, 2014 at 11:48 AM, Brian O'Shea <<a href="mailto:bwoshea@gmail.com">bwoshea@gmail.com</a>> wrote:<br>
>><br>
>><br>
>>> > +1.  I really like having the docs and the source in the same<br>
>>> > repository,<br>
>>> > for the reasons that you've listed.  Also, when I put yt on a new<br>
>>> > machine it<br>
>>> > makes it impossible for me to forget to also get the docs...  :-)<br>
>>><br>
>>> They do currently get checked out into<br>
>>> $YT_DEST/src/yt-supplemental/yt-doc , but we can get rid of that if we<br>
>>> move them back in.<br>
>><br>
>><br>
>> *facepalm*<br>
>><br>
>> Thanks!<br>
>><br>
>><br>
>> _______________________________________________<br>
>> yt-dev mailing list<br>
>> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
>> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
>><br>
><br>
><br>
><br>
> --<br>
> Cameron Hummels<br>
> Postdoctoral Researcher<br>
> Steward Observatory<br>
> University of Arizona<br>
> <a href="http://chummels.org" target="_blank">http://chummels.org</a><br>
><br>
> _______________________________________________<br>
> yt-dev mailing list<br>
> <a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
> <a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
><br>
_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
</div></div></blockquote></div><br></div></div>