From 883f3d7504a0496db07718869381a048914f3f18 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 21:10:38 +0900 Subject: [PATCH] Include README in Sphinx using the include directive (#316) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- README.md | 13 +++---------- docs/index.md | 10 +++------- 2 files changed, 6 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index efbee9a3..5993923a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,4 @@ -> [!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#--------) +[](https://github.com/pyvista/scikit-gmsh#--------) > Scikit for Gmsh to generate 3D finite element mesh. @@ -12,16 +7,14 @@ [![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. + 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/) diff --git a/docs/index.md b/docs/index.md index 9c2b9bf2..fbbbd79a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,8 @@ -# 🚧 scikit-gmsh documentation +# scikit-gmsh documentation -:::{note} -We've marked content with a 🚧 to indicate that it's still under construction. -::: +```{include} ../README.md -## 🚧 Overview - -The `sikit-gmsh` package provides a simple interface to the `gmsh` library. +``` ## Contributors