Skip to content
Open
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
58 changes: 58 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: docs

# Build the Python-bindings documentation site. The API reference is generated
# from the installed package's .pyi stubs, so it always matches the bindings.
# On pushes to main a preview is deployed to this repo's gh-pages; the canonical
# home is the unified libigl.github.io site, which can consume the same generator.

on:
push:
branches: [main]
pull_request:
paths:
- 'website/**'
- '.github/workflows/docs.yml'
- 'src/**'
workflow_dispatch:

permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install the bindings and docs tooling
run: |
python -m pip install --upgrade pip
python -m pip install libigl
python -m pip install -r website/requirements.txt

- name: Fetch libigl headers and Doxygen index (for C++ cross-links)
run: |
git clone --depth 1 https://github.com/libigl/libigl.git _libigl
curl -sSL https://libigl.github.io/dox/files.html -o _dox_files.html || true

- name: Generate the API reference
run: |
python website/generate_api.py \
--package "$(python -c 'import igl, os; print(os.path.dirname(igl.__file__))')" \
--igl-include _libigl/include \
--dox-index _dox_files.html \
--out website/docs/api

- name: Build the site
run: cd website && python -m mkdocs build --strict

- name: Deploy preview to gh-pages
if: github.event_name != 'pull_request'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: website/site
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ bin_rel
build
build-full

tutorial/data
tutorial/.ipynb_*
tutorial-old/.ipynb_*
# Generated documentation (api pages are produced by website/generate_api.py)
website/docs/api/
website/site/

test.obj
pyigl.cpython*
Expand Down
70 changes: 0 additions & 70 deletions mkdocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion src/circumradius.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ namespace pyigl
void bind_circumradius(nb::module_ &m)
{
m.def("circumradius", &pyigl::circumradius,
""_a,
"V"_a,
"F"_a,
R"(Compute the circumradius of each triangle in a mesh (V,F)
@param[in] V #V by dim list of mesh vertex positions
Expand Down
Loading