mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
b80b7e2e71
This is a start of moving the VTK-m User's Guide into the VTK-m source. This is only the start of the process. There are several goals of this work. 1. Integrate the documentation into the source code better to better keep the code up to date. 2. Move the documentation over to Sphinx so that it can be posted online and be more easily linked. 3. Incoporate Doxygen into the guide to keep the documentation consistent. 4. Build the user guide examples as part of the VTK-m CI to catch compatibility changes quickly.
57 lines
1.1 KiB
ReStructuredText
57 lines
1.1 KiB
ReStructuredText
.. title page
|
|
|
|
==============================
|
|
The VTK-m User's Guide
|
|
==============================
|
|
|
|
.. todo:: Hide TODOs for release documentation.
|
|
|
|
| **The VTK-m User's Guide**
|
|
| Version |version|
|
|
|
|
Kenneth Moreland
|
|
|
|
with special contributions from
|
|
Vicente Bolea,
|
|
Hank Childs,
|
|
Nickolas Davis,
|
|
Mark Kim,
|
|
James Kress,
|
|
Matthew Letter,
|
|
Li-Ta Lo,
|
|
Robert Maynard,
|
|
Sujin Philip,
|
|
David Pugmire,
|
|
Nick Thompson,
|
|
Allison Vacanti,
|
|
Abhishek Yenpure,
|
|
and the |VTKm| community
|
|
|
|
Moreland, K. (|report-year|). *The VTK-m User's Guide*, Tech report |report-number|, Oak Ridge National Laboratory.
|
|
|
|
.. centered:: Join the VTK-m Community at http://m.vtk.org.
|
|
|
|
.. todo:: The centered directive is deprecated (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-centered). Figure out how to add rst-class to center.
|
|
|
|
.. toctree::
|
|
:numbered:
|
|
:maxdepth: 2
|
|
:caption: VTK-m User's Guide
|
|
|
|
part-getting-started.rst
|
|
part-using.rst
|
|
part-developing.rst
|
|
part-advanced.rst
|
|
part-core.rst
|
|
part-appendix.rst
|
|
|
|
|
|
|
|
..
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|