diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 9eb89c3e..67d91613 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -1,4 +1,4 @@ -name: Build Documentation +name: Documentation on: workflow_dispatch: @@ -11,20 +11,16 @@ on: - main - master - schedule: - - cron: "0 0 * * *" - concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: - build-and-deploy: + build-doc: runs-on: "ubuntu-latest" env: PYVISTA_OFF_SCREEN: "True" ALLOW_PLOTTING: true - SHELLOPTS: "errexit:pipefail" steps: - uses: actions/checkout@v4 @@ -37,9 +33,9 @@ jobs: - uses: pyvista/setup-headless-display-action@v3 - name: Install libGLU - run: sudo apt-get install libglu1-mesa + run: sudo apt-get install -y libglu1-mesa - - name: Install + - name: Install package with docs dependencies run: pip install .[docs] - name: Build docs diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index f0a18afc..017dda84 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -13,6 +13,9 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true +env: + PYVISTA_OFF_SCREEN: "True" + jobs: run-examples: runs-on: ${{ matrix.os }} diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index fed32f3f..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -version: 2 - -build: - os: "ubuntu-22.04" - tools: - python: "3.12" - jobs: - post_install: # https://github.com/pyvista/pyvista/discussions/4024 - - pip uninstall vtk -y - - pip install vtk-osmesa --extra-index-url https://wheels.vtk.org - apt_packages: - - libglu1-mesa - -sphinx: - configuration: docs/conf.py - -python: - install: - - method: pip - path: . - extra_requirements: - - docs diff --git a/README.md b/README.md index 55f52e52..7c32a156 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Generation of 3D objects is achievable through functions that utilize Open CASCA | -------------- | ---------------- | | PyPI package | [![PyPI](https://badge.fury.io/py/microgen.svg)](https://pypi.org/project/microgen/) | | Conda forge package | [![Conda](https://anaconda.org/conda-forge/microgen/badges/version.svg)](https://anaconda.org/conda-forge/microgen) | -| Documentation | [![Documentation](https://readthedocs.org/projects/microgen/badge/?version=latest)](https://microgen.readthedocs.io/en/latest/?badge=latest) | +| Documentation | [![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://3mah.github.io/microgen-docs/) | | Status | [![Status](https://github.com/3MAH/microgen/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/3MAH/microgen) | | Citation | [![DOI](https://zenodo.org/badge/380437028.svg)](https://zenodo.org/badge/latestdoi/380437028) | | License | [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) | @@ -68,73 +68,73 @@ Click on the image to be redirected to the corresponding example on Microgen's d ### Basic shapes - + - + ### Repeated cells - + - + ### Strut-based Lattices - + - + ### Triply Periodic Minimal Surfaces (TPMS) - + - + - + - + ### 3D operations - + - + - + - + ### Mesh - + - + - + - + - + diff --git a/conda.recipe/meta.yaml b/conda.recipe/meta.yaml index b3bc7c35..8064e46a 100644 --- a/conda.recipe/meta.yaml +++ b/conda.recipe/meta.yaml @@ -44,7 +44,7 @@ about: license: GPL-3.0-or-later license_family: GPL license_file: LICENSE - doc_url: https://microgen.readthedocs.io + doc_url: https://3mah.github.io/microgen-docs/ dev_url: https://github.com/3MAH/microgen extra: diff --git a/docs/conf.py b/docs/conf.py index c95fa01b..2d63351c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,7 +67,7 @@ # html_theme = "sphinx_rtd_theme" html_theme_options = { - "canonical_url": "https://microgen.readthedocs.io/en/latest/", + "canonical_url": "https://3mah.github.io/microgen-docs/", # 'logo_only': False, # 'display_version': True, # 'prev_next_buttons_location': 'bottom', diff --git a/pyproject.toml b/pyproject.toml index 9564adec..e44f03ab 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,7 +53,7 @@ jupyter = [ all = ["microgen[dev, docs, jupyter, ray]"] [project.urls] -Documentation = 'https://microgen.readthedocs.io/en/latest' +Documentation = 'https://3mah.github.io/microgen-docs/' "Bug Tracker" = 'https://github.com/3MAH/microgen/issues' "Source Code" = 'https://github.com/3MAH/microgen'