Update docs

romanin-rf · Dec 18, 2023 · 08bc64c · 08bc64c
1 parent 6475f70
commit 08bc64c
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 3 deletions.
diff --git a/.github/workflows/docs-publing.yml b/.github/workflows/docs-publing.yml
@@ -27,6 +27,9 @@ jobs:
           cd site;
           git fetch --refetch;
           git pull https://github.com/romanin-rf/SeaPlayer.git docs;
+          cd ../src;
+          git fetch --refetch;
+          git pull https://github.com/romanin-rf/SeaPlayer.git main;
           cd ..;
       - name: Clear `docs`
         run: |

diff --git a/.gitmodules b/.gitmodules
@@ -2,3 +2,7 @@
 	path = site
 	url = https://github.com/romanin-rf/SeaPlayer.git
 	branch = docs
+[submodule "src"]
+	path = src
+	url = https://github.com/romanin-rf/SeaPlayer.git
+	branch = main
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1 @@
+# Welcome to SeaPlayer API
diff --git a/docs/api/seaplayer.md b/docs/api/seaplayer.md
@@ -0,0 +1,6 @@
+::: seaplayer.seaplayer.SeaPlayer
+    handler: python
+    options:
+        members:
+            show_root_heading: false
+            show_source: false
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,6 +6,10 @@ nav:
     - Welcome to SeaPlayer: index.md
     - Plugin CLI: plugin-cli-home.md
     - Plugin Development: plugin-dev-home.md
+  #- API:
+  #  - api/index.md
+  #  - Welcome to SeaPlayer API: api/index.md
+  #  - SeaPlayer: api/seaplayer.md
   - Сhangelog: changelog.md
 theme:
   name: material
@@ -44,4 +48,7 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.snippets
+plugins:
+  - search
+  - mkdocstrings
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
-mkdocs-material
+rich
 mkdocs
-rich
+mkdocstrings[python]
+mkdocs-material
diff --git a/src b/src