Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
simoneponcioni committed Sep 5, 2024
2 parents 954382e + 547b6aa commit 5426af7
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
20 changes: 18 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: documentation
name: Documentation

on: [push, pull_request, workflow_dispatch]

Expand All @@ -11,11 +11,27 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5

- name: Set up Python virtual environment
run: |
python -m venv venv
source venv/bin/activate
pip install --upgrade pip
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y libglu1-mesa
- name: Clone and install pyhexspline
run: |
venv/bin/pip install -e .
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
source venv/bin/activate
pip install sphinx sphinx_rtd_theme myst_parser opencv-python matplotlib gmsh numpy scipy imutils shapely SimpleITK plotly pandas
- name: Sphinx build
run: |
source venv/bin/activate
sphinx-build src/pyhexspline/docs src/pyhexspline/docs/_build
- name: Create .nojekyll file
run: |
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

![Issue creation][todo_to_issue]
![Python application][pyapp]
[![Python application](https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/python-app.yml/badge.svg)](https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/python-app.yml)
[![Documentation](https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/docs.yml/badge.svg)](https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/docs.yml)

<h3 align="center">Spline-based structured conformal hexahedral meshing</h3>

Expand Down Expand Up @@ -179,7 +179,7 @@ Simone Poncioni - [email protected]
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[issues-url]: https://github.com/artorg-unibe-ch/spline_mesher/issues

[Documentation]: https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/docs.yml/badge.svg
[Python-url]: https://www.python.org/
[GMSH-url]: http://gmsh.info/
[pyapp]: https://github.com/artorg-unibe-ch/spline_mesher/actions/workflows/python-app.yml/badge.svg
Expand Down
2 changes: 1 addition & 1 deletion src/pyhexspline/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@
# 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"]

0 comments on commit 5426af7

Please sign in to comment.