diff options
| author |   简律纯 <i@jyunko.cn> | 2024-02-24 12:56:23 +0800 |
|---|---|---|
| committer | 简律纯 <i@jyunko.cn> | 2024-02-24 12:56:23 +0800 |
| commit | 45e2f3631bc8d13dacba57e705c7591e7e707b2a (patch) | |
| tree | 8a2c5bc9d3d5faf7405f95274e0db01607d23808 /docs/source | |
| parent | ae345a2f193a4d6022edda76523a39f6e891843e (diff) | |
| download | TRPGNivis-45e2f3631bc8d13dacba57e705c7591e7e707b2a.tar.gz TRPGNivis-45e2f3631bc8d13dacba57e705c7591e7e707b2a.zip | |
chore(docs): add index, contributing, quick-start sections
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/CONTRIBUTING.rst | 2 | ||||
| -rw-r--r-- | docs/source/index.rst | 6 | ||||
| -rw-r--r-- | docs/source/pages/contributing.rst | 1 | ||||
| -rw-r--r-- | docs/source/pages/quick-start.rst | 3 |
4 files changed, 7 insertions, 5 deletions
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.rst> + Quick start <pages/quick-start.rst> .. toctree:: :caption: Development :hidden: - Contributing <pages/development/contributing.rst> - Changelog <changelog.rst> + CONTRIBUTING <pages/development/contributing.rst> + CHANGELOG <changelog.rst> COPYING <COPYING.rst>
\ 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! +===================== + |