Skip to content

Commit

Permalink
docs: editorial changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sethfischer committed Jun 11, 2023
1 parent ba85c23 commit 1c32f2d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/directives.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,10 @@ Directives

Render a CadQuery model using `kitware/vtk.js`_.

VTK JavaScript is generated using the :doc:`CadQuery Gateway Interface <cadquery-latest:cqgi>`
and :func:`cadquery-latest:cadquery.occ_impl.assembly.toJSON`.

The *path_name* argument is a path to a CadQuery source file,
relative to the Sphinx content root.

Examples:
.. rubric:: Examples

.. code-block:: rst
:caption: Default is to render the "result" object.
Expand All @@ -37,6 +34,8 @@ Directives
.. cadquery-vtk:: ../examples/simple-rectangular-plate.py
VTK JavaScript is generated using the :doc:`CadQuery Gateway Interface <cadquery-latest:cqgi>`
and :func:`cadquery-latest:cadquery.occ_impl.assembly.toJSON`.

.. versionadded:: 0.2.0
Identical to depreciated :rst:dir:`cadquery` directive.
Expand Down Expand Up @@ -82,7 +81,7 @@ Directives
The CadQuery source must call
:meth:`show_object() <cadquery-latest:cadquery.cqgi.ScriptCallback.show_object>`.

Examples:
.. rubric:: Examples

.. code-block:: rst
:caption: Render the object passed to "show_object()" as a SVG image.
Expand Down

0 comments on commit 1c32f2d

Please sign in to comment.