diff options
| author | 2024-02-24 12:56:23 +0800 | |
|---|---|---|
| committer | 2024-02-24 12:56:23 +0800 | |
| commit | 45e2f3631bc8d13dacba57e705c7591e7e707b2a (patch) | |
| tree | 8a2c5bc9d3d5faf7405f95274e0db01607d23808 | |
| parent | ae345a2f193a4d6022edda76523a39f6e891843e (diff) | |
| download | TRPGNivis-45e2f3631bc8d13dacba57e705c7591e7e707b2a.tar.gz TRPGNivis-45e2f3631bc8d13dacba57e705c7591e7e707b2a.zip | |
chore(docs): add index, contributing, quick-start sections
| -rw-r--r-- | CONTRIBUTING.md | 0 | ||||
| -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 | ||||
| -rw-r--r-- | pdm.lock | 39 | ||||
| -rw-r--r-- | pyproject.toml | 4 |
7 files changed, 19 insertions, 36 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/CONTRIBUTING.md 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! +===================== + @@ -6,7 +6,7 @@ groups = ["default", "docs"] cross_platform = true static_urls = false lock_version = "4.3" -content_hash = "sha256:b7ebf2d8e66c9393b29dbb902f2ef63012a2234c7714ece9afab8c87c8f70e84" +content_hash = "sha256:a3b2ce1d5bb6047c665fe5b29b48981225c6d7af9751e16ded436071d9eea8fc" [[package]] name = "alabaster" @@ -161,20 +161,6 @@ files = [ ] [[package]] -name = "infini" -version = "2.0.4" -requires_python = ">=3.10" -summary = "Infini 核心标准文本输入输出模块" -dependencies = [ - "jinja2>=3.1.3", - "rich>=13.7.0", -] -files = [ - {file = "infini-2.0.4-py3-none-any.whl", hash = "sha256:024f45fc6a57b111a27df2968e26da123f54ce6a764925dceef3d195798620cf"}, - {file = "infini-2.0.4.tar.gz", hash = "sha256:e6341774069a2b2f898a1b9d9928c4aed7ce1949006e03d583a907a8b60e9523"}, -] - -[[package]] name = "jinja2" version = "3.1.3" requires_python = ">=3.7" @@ -294,6 +280,15 @@ files = [ ] [[package]] +name = "ply" +version = "3.11" +summary = "Python Lex & Yacc" +files = [ + {file = "ply-3.11-py2.py3-none-any.whl", hash = "sha256:096f9b8350b65ebd2fd1346b12452efe5b9607f7482813ffca50c22722a807ce"}, + {file = "ply-3.11.tar.gz", hash = "sha256:00c7c1aaa88358b9c765b6d3000c6eec0ba42abca5351b095321aef446081da3"}, +] + +[[package]] name = "pygments" version = "2.17.2" requires_python = ">=3.7" @@ -344,20 +339,6 @@ files = [ ] [[package]] -name = "rich" -version = "13.7.0" -requires_python = ">=3.7.0" -summary = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal" -dependencies = [ - "markdown-it-py>=2.2.0", - "pygments<3.0.0,>=2.13.0", -] -files = [ - {file = "rich-13.7.0-py3-none-any.whl", hash = "sha256:6da14c108c4866ee9520bbffa71f6fe3962e193b7da68720583850cd4548e235"}, - {file = "rich-13.7.0.tar.gz", hash = "sha256:5cb5123b5cf9ee70584244246816e9114227e0b98ad9176eede6ad54bf5403fa"}, -] - -[[package]] name = "setuptools" version = "69.1.1" requires_python = ">=3.8" diff --git a/pyproject.toml b/pyproject.toml index 5fc71fd..16df8fe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,10 +6,10 @@ authors = [ {name = "简律纯", email = "i@jyunko.cn"}, ] dependencies = [ - "infini>=2.0.4", + "ply>=3.11", ] requires-python = ">=3.11" -readme = "README.md" +readme = "README.rst" license = {text = "MIT"} [build-system] |
