From 161a7b42772648c5328ede4433f3b8e89f9e726c Mon Sep 17 00:00:00 2001 From: "Xuan (Sean) Hu" Date: Mon, 11 Sep 2023 10:40:35 +0800 Subject: [PATCH] docs: Use markdown for all documentation. (#134) --- .vscode/settings.json | 1 + docs/api/index.md | 6 ++++++ docs/api/index.rst | 7 ------- docs/api/settings.md | 5 +++++ docs/api/settings.rst | 4 ---- docs/cli/index.md | 6 ++++++ docs/cli/index.rst | 6 ------ docs/index.md | 2 +- docs/reports/coverage/index.md | 3 +++ docs/reports/coverage/index.rst | 4 ---- docs/reports/index.md | 7 +++++++ docs/reports/index.rst | 8 -------- docs/reports/mypy/index.md | 3 +++ docs/reports/mypy/index.rst | 4 ---- template/.vscode/settings.json | 1 + template/docs/api/index.md.jinja | 6 ++++++ template/docs/api/index.rst.jinja | 7 ------- template/docs/api/settings.md.jinja | 5 +++++ template/docs/api/settings.rst.jinja | 4 ---- template/docs/cli/index.md.jinja | 6 ++++++ template/docs/cli/index.rst.jinja | 6 ------ template/docs/index.md.jinja | 2 +- template/docs/reports/coverage/index.md | 3 +++ template/docs/reports/coverage/index.rst | 4 ---- template/docs/reports/index.md | 7 +++++++ template/docs/reports/index.rst | 8 -------- template/docs/reports/mypy/index.md | 3 +++ template/docs/reports/mypy/index.rst | 4 ---- 28 files changed, 64 insertions(+), 68 deletions(-) create mode 100644 docs/api/index.md delete mode 100644 docs/api/index.rst create mode 100644 docs/api/settings.md delete mode 100644 docs/api/settings.rst create mode 100644 docs/cli/index.md delete mode 100644 docs/cli/index.rst create mode 100644 docs/reports/coverage/index.md delete mode 100644 docs/reports/coverage/index.rst create mode 100644 docs/reports/index.md delete mode 100644 docs/reports/index.rst create mode 100644 docs/reports/mypy/index.md delete mode 100644 docs/reports/mypy/index.rst create mode 100644 template/docs/api/index.md.jinja delete mode 100644 template/docs/api/index.rst.jinja create mode 100644 template/docs/api/settings.md.jinja delete mode 100644 template/docs/api/settings.rst.jinja create mode 100644 template/docs/cli/index.md.jinja delete mode 100644 template/docs/cli/index.rst.jinja create mode 100644 template/docs/reports/coverage/index.md delete mode 100644 template/docs/reports/coverage/index.rst create mode 100644 template/docs/reports/index.md delete mode 100644 template/docs/reports/index.rst create mode 100644 template/docs/reports/mypy/index.md delete mode 100644 template/docs/reports/mypy/index.rst diff --git a/.vscode/settings.json b/.vscode/settings.json index f032d42a..7c95f077 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -27,6 +27,7 @@ "interruptible", "isort", "JPKXI", + "maxdepth", "modindex", "mypy", "pathjoin", diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000..3d301c90 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,6 @@ +# API Reference + +```{toctree} +:maxdepth: 1 +settings +``` diff --git a/docs/api/index.rst b/docs/api/index.rst deleted file mode 100644 index aa2b6578..00000000 --- a/docs/api/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 1 - - settings diff --git a/docs/api/settings.md b/docs/api/settings.md new file mode 100644 index 00000000..357b98a0 --- /dev/null +++ b/docs/api/settings.md @@ -0,0 +1,5 @@ +# serious_scaffold.settings + +```{eval-rst} +.. automodule:: serious_scaffold.settings +``` diff --git a/docs/api/settings.rst b/docs/api/settings.rst deleted file mode 100644 index 9aa92fbe..00000000 --- a/docs/api/settings.rst +++ /dev/null @@ -1,4 +0,0 @@ -serious_scaffold.settings -========================= - -.. automodule:: serious_scaffold.settings diff --git a/docs/cli/index.md b/docs/cli/index.md new file mode 100644 index 00000000..112c2145 --- /dev/null +++ b/docs/cli/index.md @@ -0,0 +1,6 @@ +# CLI Reference + +```{click} serious_scaffold.cli:typer_click_object +:prog: serious-scaffold-cli +:nested: full +``` diff --git a/docs/cli/index.rst b/docs/cli/index.rst deleted file mode 100644 index c3798ecb..00000000 --- a/docs/cli/index.rst +++ /dev/null @@ -1,6 +0,0 @@ -CLI Reference -============= - -.. click:: serious_scaffold.cli:typer_click_object - :prog: serious-scaffold-cli - :nested: full diff --git a/docs/index.md b/docs/index.md index b54a6f9a..2fbdfa4b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Welcome to Serious Scaffold Python's documentation! +# Welcome to Serious Scaffold Python's documentation ```{toctree} :hidden: diff --git a/docs/reports/coverage/index.md b/docs/reports/coverage/index.md new file mode 100644 index 00000000..d362f0ad --- /dev/null +++ b/docs/reports/coverage/index.md @@ -0,0 +1,3 @@ +# Coverage Reports + + diff --git a/docs/reports/coverage/index.rst b/docs/reports/coverage/index.rst deleted file mode 100644 index 95f61be3..00000000 --- a/docs/reports/coverage/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -Coverage Reports -================ - -This is a placeholder for coverage reports which supposed to be overridden. diff --git a/docs/reports/index.md b/docs/reports/index.md new file mode 100644 index 00000000..fd723017 --- /dev/null +++ b/docs/reports/index.md @@ -0,0 +1,7 @@ +# Code Quality Reports + +```{toctree} +:maxdepth: 2 +mypy/index +coverage/index +``` diff --git a/docs/reports/index.rst b/docs/reports/index.rst deleted file mode 100644 index cf491a7c..00000000 --- a/docs/reports/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Code Quality Reports -==================== - -.. toctree:: - :maxdepth: 2 - - mypy/index - coverage/index diff --git a/docs/reports/mypy/index.md b/docs/reports/mypy/index.md new file mode 100644 index 00000000..10d61d08 --- /dev/null +++ b/docs/reports/mypy/index.md @@ -0,0 +1,3 @@ +# MyPy Reports + + diff --git a/docs/reports/mypy/index.rst b/docs/reports/mypy/index.rst deleted file mode 100644 index 16f27ab4..00000000 --- a/docs/reports/mypy/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -MyPy Reports -============ - -This is a placeholder for mypy reports which supposed to be overridden. diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json index f032d42a..7c95f077 100644 --- a/template/.vscode/settings.json +++ b/template/.vscode/settings.json @@ -27,6 +27,7 @@ "interruptible", "isort", "JPKXI", + "maxdepth", "modindex", "mypy", "pathjoin", diff --git a/template/docs/api/index.md.jinja b/template/docs/api/index.md.jinja new file mode 100644 index 00000000..3d301c90 --- /dev/null +++ b/template/docs/api/index.md.jinja @@ -0,0 +1,6 @@ +# API Reference + +```{toctree} +:maxdepth: 1 +settings +``` diff --git a/template/docs/api/index.rst.jinja b/template/docs/api/index.rst.jinja deleted file mode 100644 index aa2b6578..00000000 --- a/template/docs/api/index.rst.jinja +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 1 - - settings diff --git a/template/docs/api/settings.md.jinja b/template/docs/api/settings.md.jinja new file mode 100644 index 00000000..f8b1f4ad --- /dev/null +++ b/template/docs/api/settings.md.jinja @@ -0,0 +1,5 @@ +# {{ module_name }}.settings + +```{eval-rst} +.. automodule:: {{ module_name }}.settings +``` diff --git a/template/docs/api/settings.rst.jinja b/template/docs/api/settings.rst.jinja deleted file mode 100644 index a2332f8e..00000000 --- a/template/docs/api/settings.rst.jinja +++ /dev/null @@ -1,4 +0,0 @@ -{{ module_name }}.settings -========================= - -.. automodule:: {{ module_name }}.settings diff --git a/template/docs/cli/index.md.jinja b/template/docs/cli/index.md.jinja new file mode 100644 index 00000000..ac0caf55 --- /dev/null +++ b/template/docs/cli/index.md.jinja @@ -0,0 +1,6 @@ +# CLI Reference + +```{click} {{ module_name }}.cli:typer_click_object +:prog: {{ package_name }}-cli +:nested: full +``` diff --git a/template/docs/cli/index.rst.jinja b/template/docs/cli/index.rst.jinja deleted file mode 100644 index 47c8c1cf..00000000 --- a/template/docs/cli/index.rst.jinja +++ /dev/null @@ -1,6 +0,0 @@ -CLI Reference -============= - -.. click:: {{ module_name }}.cli:typer_click_object - :prog: {{ package_name }}-cli - :nested: full diff --git a/template/docs/index.md.jinja b/template/docs/index.md.jinja index d9c7df07..b4cd6ce7 100644 --- a/template/docs/index.md.jinja +++ b/template/docs/index.md.jinja @@ -1,4 +1,4 @@ -# Welcome to {{ project_name }}'s documentation! +# Welcome to {{ project_name }}'s documentation ```{toctree} :hidden: diff --git a/template/docs/reports/coverage/index.md b/template/docs/reports/coverage/index.md new file mode 100644 index 00000000..d362f0ad --- /dev/null +++ b/template/docs/reports/coverage/index.md @@ -0,0 +1,3 @@ +# Coverage Reports + + diff --git a/template/docs/reports/coverage/index.rst b/template/docs/reports/coverage/index.rst deleted file mode 100644 index 95f61be3..00000000 --- a/template/docs/reports/coverage/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -Coverage Reports -================ - -This is a placeholder for coverage reports which supposed to be overridden. diff --git a/template/docs/reports/index.md b/template/docs/reports/index.md new file mode 100644 index 00000000..fd723017 --- /dev/null +++ b/template/docs/reports/index.md @@ -0,0 +1,7 @@ +# Code Quality Reports + +```{toctree} +:maxdepth: 2 +mypy/index +coverage/index +``` diff --git a/template/docs/reports/index.rst b/template/docs/reports/index.rst deleted file mode 100644 index cf491a7c..00000000 --- a/template/docs/reports/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Code Quality Reports -==================== - -.. toctree:: - :maxdepth: 2 - - mypy/index - coverage/index diff --git a/template/docs/reports/mypy/index.md b/template/docs/reports/mypy/index.md new file mode 100644 index 00000000..10d61d08 --- /dev/null +++ b/template/docs/reports/mypy/index.md @@ -0,0 +1,3 @@ +# MyPy Reports + + diff --git a/template/docs/reports/mypy/index.rst b/template/docs/reports/mypy/index.rst deleted file mode 100644 index 16f27ab4..00000000 --- a/template/docs/reports/mypy/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -MyPy Reports -============ - -This is a placeholder for mypy reports which supposed to be overridden.