<div dir="ltr"><div><div>Hi all,<br><br></div>As of a few days ago the master branch has a sphinx-build option integrated into CMB's cmake (variable name CMB_ENABLE_DOCUMENTATION). Turning on the flag will create an HTML documentation in the build/Documentation/user directory.<br><br></div>A <a href="http://readthedocs.org">readthedocs.org</a> webhook is being planned.<br></div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Jul 2, 2015 at 3:05 PM, Dylan Wang <span dir="ltr"><<a href="mailto:dylan.wang@kitware.com" target="_blank">dylan.wang@kitware.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><span class=""><div><div>I actually realized I should switch to git after writing a bit of
it but I wanted to push a draft out. I'll take a look at Sphinx.<br><br></div>David,
I think following use cases is a good idea. Maybe moving the
documentation stuff (what's currently written) to the back and starting
with use cases is better.<br><br></div>Thanks Yumin for the paraview link. I looked for an old ModelBuilder manual and I don't think there is one.</span><div><div><img src="https://ssl.gstatic.com/ui/v1/icons/mail/images/cleardot.gif"></div></div></div><div class="gmail_extra"><br><div class="gmail_quote"><span class="">On Thu, Jul 2, 2015 at 2:05 PM, Yumin Yuan <span dir="ltr"><<a href="mailto:yumin.yuan@kitware.com" target="_blank">yumin.yuan@kitware.com</a>></span> wrote:<br></span><div><div class="h5"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Hi Dylan,<div><br></div><div>If you haven't seem this, here is <a href="http://www.paraview.org/paraview-guide/" target="_blank">the paraview guide</a> that you could use as a reference.</div><div><br></div><div>I think what you wrote is a good base for describing ModelBuilder UI, and I agree with Dave, we will need other sections from use cases point of view, such as loading models from different kernels, supported model operations, how to do meshing, how to create simulation input files, etc.</div><div><br></div><div>Another thing to keep in mind is that CMB suite includes (or will include ) other applications (PointsBuilder, SceneBuilder, MeshViewer at least), and some of the UI components are the same across all these applications.</div><span><font color="#888888"><div><br></div><div>Yumin</div></font></span></div><div class="gmail_extra"><br><div class="gmail_quote"><div><div>On Thu, Jul 2, 2015 at 1:32 PM, David Thompson <span dir="ltr"><<a href="mailto:david.thompson@kitware.com" target="_blank">david.thompson@kitware.com</a>></span> wrote:<br></div></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div><span>> What are you using to make the pdf? I'd recommend something like Latex that works well with git.<br>
<br>
</span>I second this and would add Sphinx as a possibility since it has good online-HTML plus PDF output. (See <a href="https://smtk.rtfd.org/" rel="noreferrer" target="_blank">https://smtk.rtfd.org/</a> for an example.)<br>
<span><font color="#888888"><br>
David<br>
</font></span></div></div><span><div><div>_______________________________________________<br>
Cmb-users mailing list<br>
<a href="mailto:Cmb-users@computationalmodelbuilder.org" target="_blank">Cmb-users@computationalmodelbuilder.org</a><br>
<a href="http://public.kitware.com/mailman/listinfo/cmb-users" rel="noreferrer" target="_blank">http://public.kitware.com/mailman/listinfo/cmb-users</a><br>
</div></div></span></blockquote></div><br></div>
<br>_______________________________________________<br>
Cmb-users mailing list<br>
<a href="mailto:Cmb-users@computationalmodelbuilder.org" target="_blank">Cmb-users@computationalmodelbuilder.org</a><br>
<a href="http://public.kitware.com/mailman/listinfo/cmb-users" rel="noreferrer" target="_blank">http://public.kitware.com/mailman/listinfo/cmb-users</a><br>
<br></blockquote></div></div></div><br></div>
</blockquote></div><br></div>