From 45e2f3631bc8d13dacba57e705c7591e7e707b2a Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sat, 24 Feb 2024 12:56:23 +0800 Subject: chore(docs): add index, contributing, quick-start sections --- docs/source/CONTRIBUTING.rst | 2 -- docs/source/index.rst | 6 +++--- docs/source/pages/contributing.rst | 1 + docs/source/pages/quick-start.rst | 3 +++ 4 files changed, 7 insertions(+), 5 deletions(-) delete mode 100644 docs/source/CONTRIBUTING.rst create mode 100644 docs/source/pages/quick-start.rst (limited to 'docs') diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst deleted file mode 100644 index e75758c..0000000 --- a/docs/source/CONTRIBUTING.rst +++ /dev/null @@ -1,2 +0,0 @@ -```{include} ../../CONTRIBUTING.md -``` \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 5ddf853..3b2f020 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,13 +11,13 @@ Nivis - ❄ .. toctree:: :hidden: - Quick start + Quick start .. toctree:: :caption: Development :hidden: - Contributing - Changelog + CONTRIBUTING + CHANGELOG COPYING \ No newline at end of file diff --git a/docs/source/pages/contributing.rst b/docs/source/pages/contributing.rst index e69de29..64b74a9 100644 --- a/docs/source/pages/contributing.rst +++ b/docs/source/pages/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/source/pages/quick-start.rst b/docs/source/pages/quick-start.rst new file mode 100644 index 0000000..61ba1ad --- /dev/null +++ b/docs/source/pages/quick-start.rst @@ -0,0 +1,3 @@ +Welcome to the nivis! +===================== + -- cgit v1.2.3-70-g09d2