From 81ce7ef56f7fe153506f51d9731e5b06cc85a586 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 12:25:42 +0900 Subject: [PATCH 01/17] Include README in Sphinx using the include directive --- docs/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/index.md b/docs/index.md index 9c2b9bf2..bf5fa2b8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,10 @@ We've marked content with a 🚧 to indicate that it's still under construction. The `sikit-gmsh` package provides a simple interface to the `gmsh` library. +```{include} ../README.md + +``` + ## Contributors :::{include} ../CONTRIBUTORS.md From fb2c806eee06bf89b22411b3c932273e96504bf3 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 12:43:59 +0900 Subject: [PATCH 02/17] Update README.md --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 237db1d2..ba851601 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ -> [!CAUTION] -> scikit-gmsh is in the pre-alpha stage. The interface could be subject to significant changes soon. - # scikit-gmsh [](https://github.com/pyvista/scikit-gmsh#--------) From 81262c26eb8262b806c563cfc21eda9efa8df32c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 12:45:07 +0900 Subject: [PATCH 03/17] Update index.md --- docs/index.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/index.md b/docs/index.md index bf5fa2b8..3a799251 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,3 @@ -# 🚧 scikit-gmsh documentation - -:::{note} -We've marked content with a 🚧 to indicate that it's still under construction. -::: - -## 🚧 Overview - -The `sikit-gmsh` package provides a simple interface to the `gmsh` library. - ```{include} ../README.md ``` From 1b40e2f94dd3fa9956ca0d29002712efbc70ee3c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 12:46:34 +0900 Subject: [PATCH 04/17] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ba851601..4dea0d7e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ [![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg)](https://github.com/pyvista/scikit-gmsh/issues) [![GitHub Repo stars](https://img.shields.io/github/stars/pyvista/scikit-gmsh)](https://github.com/pyvista/scikit-gmsh/stargazers) +The `sikit-gmsh` package provides a simple interface to the `gmsh` library. + Contributions are _very welcome_ . This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, We want you to know that you agree to follow its terms. From 1b88afe0213a7359855666cf0e6172b80e02a855 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:01:52 +0900 Subject: [PATCH 05/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4dea0d7e..3e4614fd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # scikit-gmsh -[](https://github.com/pyvista/scikit-gmsh#--------) +[](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. From ef03b92e9de1d8069b135004d7504d831ff430e9 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:03:30 +0900 Subject: [PATCH 06/17] Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 3e4614fd..eaf569ad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# scikit-gmsh - [](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. @@ -7,6 +5,7 @@ [![All Contributors](https://img.shields.io/github/all-contributors/pyvista/scikit-gmsh?color=ee8449)](https://scikit-gmsh.readthedocs.io/en/latest/reference/about.html#contributors) [![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg)](https://github.com/pyvista/scikit-gmsh/issues) [![GitHub Repo stars](https://img.shields.io/github/stars/pyvista/scikit-gmsh)](https://github.com/pyvista/scikit-gmsh/stargazers) +[![Documentation Status](https://readthedocs.org/projects/scikit-gmsh/badge/?version=latest)](https://scikit-gmsh.readthedocs.io/en/latest/?badge=latest) The `sikit-gmsh` package provides a simple interface to the `gmsh` library. @@ -22,8 +21,6 @@ Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/ ## Table of Contents -[![Documentation Status](https://readthedocs.org/projects/scikit-gmsh/badge/?version=latest)](https://scikit-gmsh.readthedocs.io/en/latest/?badge=latest) - From a0306b2d5b3e2f9844c79c103e88672231189b80 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:04:23 +0900 Subject: [PATCH 07/17] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 43d7ac20..64be7903 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -92,12 +92,6 @@ repos: args: [--branch, main] - id: requirements-txt-fixer - id: trailing-whitespace - - repo: https://github.com/thlorenz/doctoc - rev: v2.2.0 - hooks: - - id: doctoc - args: ["--maxlevel", "3"] - exclude: docs - repo: https://github.com/pappasam/toml-sort rev: v0.23.1 hooks: From 276b2e3b570f5ba5e5f2c467bf80f8854d987a8c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:05:13 +0900 Subject: [PATCH 08/17] Update README.md --- README.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/README.md b/README.md index eaf569ad..1b01b071 100644 --- a/README.md +++ b/README.md @@ -17,20 +17,6 @@ By participating in this project, We want you to know that you agree to follow i Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/pyvista/scikit-gmsh) — it’s a simple click that means the world to us and helps others discover it, too! ⭐️ ---- - -## Table of Contents - - - - -- [Installation](#installation) -- [Usage](#usage) -- [License](#license) -- [Star History](#star-history) - - - ## Installation [![pypi](https://img.shields.io/pypi/v/scikit-gmsh?label=pypi&logo=python&logoColor=white)](https://pypi.org/project/scikit-gmsh/) From c07dee358715753ebbe370896a17d09e3c5e0470 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:06:26 +0900 Subject: [PATCH 09/17] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a25b260e..20c5113a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,8 +10,3 @@ - < feature1 or bug1 description > - < feature2 or bug2 description > - - - - - From 89ad528ca1c315fb2a526c4d428b54af42edac40 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:07:20 +0900 Subject: [PATCH 10/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 26 -------------------------- 1 file changed, 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6c77f6b..603919aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,31 +1,5 @@ # Contributing - - - -- [Being Respectful](#being-respectful) -- [Cloning the Source Repository](#cloning-the-source-repository) -- [Quick Start Development with Codespaces](#quick-start-development-with-codespaces) -- [Questions](#questions) -- [Reporting Bugs](#reporting-bugs) -- [Feature Requests](#feature-requests) -- [Contributing New Code](#contributing-new-code) -- [Licensing](#licensing) -- [Development Practices](#development-practices) - - [Guidelines](#guidelines) - - [Contributing to scikit-gmsh through GitHub](#contributing-to-scikit-gmsh-through-github) - - [Unit Testing](#unit-testing) - - [Documentation Testing](#documentation-testing) - - [Style Checking](#style-checking) - - [Notes Regarding Image Regression Testing](#notes-regarding-image-regression-testing) - - [Building the Documentation](#building-the-documentation) - - [Contributing to the Documentation](#contributing-to-the-documentation) - - [Creating a New Pull Request](#creating-a-new-pull-request) - - [Preview the Documentation](#preview-the-documentation) - - [Branching Model](#branching-model) - - - We absolutely welcome contributions and we hope that this guide will facilitate an understanding of the scikit-gmsh code repository. It is important to note that the scikit-gmsh software package is maintained on From f8fb44c343528361ca760577c247dd3a2aaedba7 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:18:28 +0900 Subject: [PATCH 11/17] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 62a8ec0b..def8b3be 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,22 +1,5 @@ # Contributor Covenant Code of Conduct - - - -- [Our Pledge](#our-pledge) -- [Our Standards](#our-standards) -- [Enforcement Responsibilities](#enforcement-responsibilities) -- [Scope](#scope) -- [Enforcement](#enforcement) -- [Enforcement Guidelines](#enforcement-guidelines) - - [1. Correction](#1-correction) - - [2. Warning](#2-warning) - - [3. Temporary Ban](#3-temporary-ban) - - [4. Permanent Ban](#4-permanent-ban) -- [Attribution](#attribution) - - - ## Our Pledge We as members, contributors, and leaders pledge to make participation in our From 290473a413ac0113b2b8273c72ddc0d606532f74 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 12 Aug 2024 13:18:54 +0900 Subject: [PATCH 12/17] Update SECURITY.md --- SECURITY.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index e7b257d9..63d9ad79 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,13 +1,5 @@ # Security Policy - - - -- [Supported Versions](#supported-versions) -- [Reporting a Vulnerability](#reporting-a-vulnerability) - - - ## Supported Versions Security vulnerability reports will be accepted and acted upon for all released versions. From c88cabf651ebba3b893b4315766e0b457caeac71 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 20:54:28 +0900 Subject: [PATCH 13/17] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6c126536..092eb1c5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# scikit-gmsh + [](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. From 56d17ab4163aec800cc680882321082284ce755b Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 21:02:16 +0900 Subject: [PATCH 14/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 092eb1c5..a4651793 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# scikit-gmsh +## scikit-gmsh [](https://github.com/pyvista/scikit-gmsh#--------) From bc9f3dc5a6119d9984d5c781047139f7133d6f53 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 21:07:17 +0900 Subject: [PATCH 15/17] Update index.md --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 3a799251..89897d1a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,4 @@ +# scikit-gmsh documentation ```{include} ../README.md ``` From 3df1f89a480cba81f3633f9d044508aae4575522 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 16 Aug 2024 12:07:28 +0000 Subject: [PATCH 16/17] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 89897d1a..fbbbd79a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ # scikit-gmsh documentation + ```{include} ../README.md ``` From 4fb2c8cff15cf19dd5594fe51cb5d9bc884a805c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 21:07:45 +0900 Subject: [PATCH 17/17] Update README.md --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index a4651793..5993923a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -## scikit-gmsh - [](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. @@ -15,12 +13,8 @@ Contributions are _very welcome_ . This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, We want you to know that you agree to follow its terms. ---- - Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/pyvista/scikit-gmsh) — it’s a simple click that means the world to us and helps others discover it, too! ⭐️ ---- - ## Installation [![pypi](https://img.shields.io/pypi/v/scikit-gmsh?label=pypi&logo=python&logoColor=white)](https://pypi.org/project/scikit-gmsh/)