Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,21 @@ jobs:
curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/build-and-test-py-project.sh
. ./build-and-test-py-project.sh

docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
-
uses: actions/setup-python@v1
with:
python-version: '3.x'
- name: "Main Script"
run: |
EXTRA_INSTALL="numpy pybind11"
curl -L -O -k https://gitlab.tiker.net/inducer/ci-support/raw/master/ci-support.sh
. ci-support.sh
build_py_project_in_venv
build_docs

# vim: sw=4
2 changes: 0 additions & 2 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,3 @@ Documentation:
- ". ./build-docs.sh"
tags:
- python3
only:
- master
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def get_version():
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down
19 changes: 12 additions & 7 deletions doc/tri-tet.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Triangle/TetGen interface
=========================

.. module:: meshpy

Some common notions
-------------------

Expand Down Expand Up @@ -64,16 +66,17 @@ Some common notions

points[2,1] = 17




:mod:`meshpy.triangle` -- Triangular Meshing
--------------------------------------------
.. module:: meshpy.triangle
:synopsis: Generate triangular meshes
.. moduleauthor:: Andreas Klöckner <[email protected]>


.. class:: ForeignArray

See :class:`meshpy.ForeignArray` for shared documentation.

.. class:: MeshInfo

:class:`MeshInfo` objects are picklable.
Expand All @@ -87,13 +90,13 @@ Some common notions
.. attribute:: point_attributes

If :attr:`MeshInfo.number_of_point_attributes` is non-zero, this is a
:class:`ForeignArray` of :class:`floats` of point attributes.
:class:`ForeignArray` of :class:`float`\ s of point attributes.

This element's size is tied to that of :attr:`MeshInfo.points`.

.. attribute:: point_markers

:class:`ForeignArray` of :class:`floats` of point attributes.
:class:`ForeignArray` of :class:`float`\ s of point attributes.

This element's size is tied to that of :attr:`MeshInfo.points`.

Expand Down Expand Up @@ -181,6 +184,10 @@ Some common notions
:synopsis: Generate triangular meshes
.. moduleauthor:: Andreas Klöckner <[email protected]>

.. class:: ForeignArray

See :class:`meshpy.ForeignArray` for shared documentation.

.. class:: Options(switches='pq', **kwargs)

Run time switches for TetGen. See the TetGen documentation for the meaning of each
Expand All @@ -199,7 +206,6 @@ Some common notions
.. attribute:: fixedvolume
.. attribute:: insertaddpoints
.. attribute:: regionattrib
.. attribute:: offcenter
.. attribute:: conformdel
.. attribute:: diagnose
.. attribute:: zeroindex
Expand All @@ -224,7 +230,6 @@ Some common notions
.. attribute:: nojettison
.. attribute:: steiner
.. attribute:: fliprepair
.. attribute:: offcenter
.. attribute:: docheck
.. attribute:: quiet
.. attribute:: verbose
Expand Down