Skip to content

Commit

Permalink
fix docs: add module docstring for TetGen
Browse files Browse the repository at this point in the history
  • Loading branch information
@j-fu
j-fu committed Nov 28, 2024
1 parent 43772c2 commit debfb1c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ tetrahedralizations, constrained Delaunay tetrahedralizations, and
quality tetrahedral meshes. TetGen.jl provides a Julia interface to
TetGen.


```@docs
TetGen
```


## Mesh based API
This API uses instances of types from [GeometryBasics.jl](https://github.com/JuliaGeometry/GeometryBasics.jl)
to describe input and output of TetGen.
Expand Down

2 comments on commit debfb1c

@j-fu
Copy link
Member Author

@j-fu j-fu commented on debfb1c Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/120357

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v2.0.0 -m "<description of version>" debfb1cec553c1bdd591f871bb3e9c7ca2f5df84
git push origin v2.0.0

Please sign in to comment.