docs: rst -> md

phi-friday · Oct 29, 2024 · 4dcc3a3 · 4dcc3a3
1 parent 78d2206
commit 4dcc3a3
Show file tree

Hide file tree

Showing 21 changed files with 122 additions and 238 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,4 +9,4 @@ build:
     - asdf install uv latest
     - asdf global uv latest
     - uv sync --group docs
-    - uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en src/docs $READTHEDOCS_OUTPUT/html
+    - NO_COLOR=1 uv run mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html
diff --git a/Makefile b/Makefile
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,105 @@
+site_name: typed-diskcache
+site_url: https://async-wrapper.readthedocs.io
+repo_url: https://github.com/phi-friday/async-wrapper
+repo_name: phi-friday/async-wrapper
+docs_dir: src/docs
+site_author: Choi Min-yeong
+copyright: 2023-2024, Choi Min-yeong
+watch:
+  - src/async_wrapper
+nav:
+  - README: index.md
+  - LICENSE: license.md
+  - API:
+      - Convert: api/convert.md
+      - Pipe: api/pipe.md
+      - Queue: api/queue.md
+      - TaskGroup: api/task_group.md
+      - Wait: api/wait.md
+      - Exception: api/exception.md
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default 
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  features:
+    - navigation.instant
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - toc.follow
+    - content.code.copy
+markdown_extensions:
+  - pymdownx.snippets
+  - pymdownx.tasklist
+  - pymdownx.highlight:
+      linenums: true
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths:
+            - src
+          import:
+            - https://docs.python.org/3/objects.inv
+            - https://anyio.readthedocs.io/en/stable/objects.inv
+          options:
+            # general
+            allow_inspection: true
+            show_bases: true
+            show_source: true
+            # title
+            heading_level: 1
+            parameter_headings: true
+            show_root_toc_entry: true
+            show_root_heading: true
+            show_root_full_path: false
+            show_root_members_full_path: false
+            show_object_full_path: false
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            # members
+            members: null
+            inherited_members: true
+            members_order: source
+            summary: false
+            show_labels: true
+            filters:
+              - "!^_[^_]"
+            # docstring
+            docstring_style: google
+            docstring_options:
+              ignore_init_summary: true
+              trim_doctest_flags: true
+            docstring_section_style: table
+            merge_init_into_class: true
+            # signatures
+            annotations_path: "brief"
+            line_length: 60
+            show_signature: true
+            show_signature_annotations: true
+            separate_signature: true
+            signature_crossrefs: true
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,19 +51,10 @@ dev = [
     "async_wrapper[uvloop,sqlalchemy]",
 ]
 docs = [
-    "linkify-it-py>=2.0.3; python_version < '3.10'",
-    "myst-parser>=3.0.1; python_version < '3.10'",
-    "sphinx-autodoc-typehints>=2.3.0; python_version < '3.10'",
-    "sphinx-immaterial>=0.12.4; python_version < '3.10'",
-    "sphinx>=7.4.7; python_version < '3.10'",
-    # 3.10
-    "linkify-it-py>=2.0.3; python_version >= '3.10'",
-    "myst-parser>=4.0.0; python_version >= '3.10'",
-    "sphinx>=8.1.3; python_version >= '3.10'",
-    "sphinx-autodoc-typehints>=2.5.0; python_version >= '3.10'",
-    "sphinx-immaterial>=0.12.4; python_version >= '3.10'",
-    #
-    "tomli>=2"
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.42",
+    "mkdocstrings[python]>=0.26.2",
+    "black>=24.10.0",
 ]
 
 [tool.uv]

diff --git a/src/docs/api/convert.md b/src/docs/api/convert.md
@@ -0,0 +1 @@
+::: async_wrapper.convert
diff --git a/src/docs/api/exception.md b/src/docs/api/exception.md
@@ -0,0 +1 @@
+::: async_wrapper.exception
diff --git a/src/docs/api/pipe.md b/src/docs/api/pipe.md
@@ -0,0 +1 @@
+::: async_wrapper.pipe
diff --git a/src/docs/api/queue.md b/src/docs/api/queue.md
@@ -0,0 +1 @@
+::: async_wrapper.queue
diff --git a/src/docs/api/task_group.md b/src/docs/api/task_group.md
@@ -0,0 +1 @@
+::: async_wrapper.task_group
diff --git a/src/docs/api/wait.md b/src/docs/api/wait.md
@@ -0,0 +1 @@
+::: async_wrapper.wait
diff --git a/src/docs/async_wrapper/convert.rst b/src/docs/async_wrapper/convert.rst
diff --git a/src/docs/async_wrapper/exception.rst b/src/docs/async_wrapper/exception.rst
diff --git a/src/docs/async_wrapper/index.rst b/src/docs/async_wrapper/index.rst
diff --git a/src/docs/async_wrapper/pipe.rst b/src/docs/async_wrapper/pipe.rst
diff --git a/src/docs/async_wrapper/queue.rst b/src/docs/async_wrapper/queue.rst
diff --git a/src/docs/async_wrapper/task_group.rst b/src/docs/async_wrapper/task_group.rst
diff --git a/src/docs/async_wrapper/wait.rst b/src/docs/async_wrapper/wait.rst
diff --git a/src/docs/conf.py b/src/docs/conf.py
diff --git a/src/docs/index.md b/src/docs/index.md
@@ -0,0 +1,3 @@
+--8<-----
+README.md
+--8<-----
diff --git a/src/docs/index.rst b/src/docs/index.rst