[Cmb-users] Modelbuilder User Manual draft

[Dylan Wang]

Hi all,

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.

A readthedocs.org webhook is being planned.

On Thu, Jul 2, 2015 at 3:05 PM, Dylan Wang <dylan.wang at kitware.com> wrote:

> 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.
>
> 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.
>
> Thanks Yumin for the paraview link. I looked for an old ModelBuilder
> manual and I don't think there is one.
>
> On Thu, Jul 2, 2015 at 2:05 PM, Yumin Yuan <yumin.yuan at kitware.com> wrote:
>
>> Hi Dylan,
>>
>> If you haven't seem this, here is the paraview guide
>> <http://www.paraview.org/paraview-guide/> that you could use as a
>> reference.
>>
>> 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.
>>
>> 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.
>>
>> Yumin
>>
>> On Thu, Jul 2, 2015 at 1:32 PM, David Thompson <
>> david.thompson at kitware.com> wrote:
>>
>>> > What are you using to make the pdf? I'd recommend something like Latex
>>> that works well with git.
>>>
>>> I second this and would add Sphinx as a possibility since it has good
>>> online-HTML plus PDF output. (See https://smtk.rtfd.org/ for an
>>> example.)
>>>
>>>         David
>>> _______________________________________________
>>> Cmb-users mailing list
>>> Cmb-users at computationalmodelbuilder.org
>>> http://public.kitware.com/mailman/listinfo/cmb-users
>>>
>>
>>
>> _______________________________________________
>> Cmb-users mailing list
>> Cmb-users at computationalmodelbuilder.org
>> http://public.kitware.com/mailman/listinfo/cmb-users
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/cmb-users/attachments/20150731/95d4b10e/attachment.html>