docs update (#91)

ro-py · Nov 14, 2023 · 63afcba · 63afcba
1 parent 11c9f4e
commit 63afcba
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 35 deletions.
diff --git a/.github/workflows/dev-docs.yml b/.github/workflows/dev-docs.yml
@@ -19,25 +19,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      
+
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.9.7"
-      
+          python-version: "3.10.9"
+
       - name: Install dependencies
         run: |
           pip install git+https://github.com/squidfunk/[email protected]
-          pip install mkdocstrings httpx mkdocs-literate-nav mkdocs-gen-files mike
-      
+          pip install mkdocstrings[python-legacy] httpx mkdocs-literate-nav mkdocs-gen-files mike
+
       - name: Configure Git user
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
-      
+
       - name: Deploy docs
         run: |
-          mike deploy --push dev
+          mike deploy dev --push
diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -20,23 +20,19 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.9.7"
-      
+          python-version: "3.10.9"
+
       - name: Install dependencies
         run: |
           pip install git+https://github.com/squidfunk/[email protected]
-          pip install mkdocstrings httpx mkdocs-literate-nav mkdocs-gen-files mike
-      
-      - name: Build docs
-        run: |
-          mkdocs build
-      
+          pip install mkdocstrings[python-legacy] httpx mkdocs-literate-nav mkdocs-gen-files mike
+
       - name: Configure Git user
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
-      
+
       - name: Deploy docs
         run: |
-          mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
-          mike set-default --push latest
+          mike deploy ${{ github.event.release.tag_name }} --push
+          mike alias ${{ github.event.release.tag_name }} latest --update-aliases --push
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,12 +1,12 @@
 * [Overview](index.md)
-* [Tutorial](tutorial/index.md)
-    * [Get Started](tutorial/get-started.md)
-    * [Authentication](tutorial/authentication.md)
-    * [Error Handling](tutorial/error-handling.md)
-    * [Thumbnails](tutorial/thumbnails.md)
-    * [Pagination](tutorial/pagination.md)
-* [ROBLOSECURITY](roblosecurity.md)
-* [Bases](bases.md)
-* [Extensions](extensions.md)
-* [Migrating to v2.0](migrating.md)
+* [Tutorials](tutorials/index.md)
+    * [Get Started](tutorials/get-started.md)
+    * [Authentication](tutorials/authentication.md)
+    * [Error Handling](tutorials/error-handling.md)
+    * [Thumbnails](tutorials/thumbnails.md)
+	* [Pagination](tutorials/pagination.md)
+	* [ROBLOSECURITY](tutorials/roblosecurity.md)
+	* [Bases](tutorials/bases.md)
+	* [Extensions](tutorials/extensions.md)
+	* [Migrating to v2.0](tutorials/migrating.md)
 * [Code Reference](reference/)
diff --git a/docs/index.md b/docs/index.md
@@ -23,7 +23,8 @@ To install ro.py from PyPI, you can install with pip:
 pip install roblox
 ```
 
-To install ro.py from git, run the following:
+To install the latest unstable version of ro.py, install [git-scm](https://git-scm.com/downloads) and run the following:
 ```
-pip install https://github.com/ro-py/ro.py
+pip install git+git://github.com/ro-py/ro.py.git
+pip install git+https://github.com/ro-py/ro.py.git
 ```
diff --git a/docs/tutorial/authentication.md → docs/tutorials/authentication.md b/docs/tutorial/authentication.md → docs/tutorials/authentication.md
diff --git a/docs/bases.md → docs/tutorials/bases.md b/docs/bases.md → docs/tutorials/bases.md
diff --git a/docs/tutorial/error-handling.md → docs/tutorials/error-handling.md b/docs/tutorial/error-handling.md → docs/tutorials/error-handling.md
diff --git a/docs/extensions.md → docs/tutorials/extensions.md b/docs/extensions.md → docs/tutorials/extensions.md
diff --git a/docs/tutorial/get-started.md → docs/tutorials/get-started.md b/docs/tutorial/get-started.md → docs/tutorials/get-started.md
diff --git a/docs/tutorial/index.md → docs/tutorials/index.md b/docs/tutorial/index.md → docs/tutorials/index.md
diff --git a/docs/migrating.md → docs/tutorials/migrating.md b/docs/migrating.md → docs/tutorials/migrating.md
diff --git a/docs/tutorial/pagination.md → docs/tutorials/pagination.md b/docs/tutorial/pagination.md → docs/tutorials/pagination.md
diff --git a/docs/roblosecurity.md → docs/tutorials/roblosecurity.md b/docs/roblosecurity.md → docs/tutorials/roblosecurity.md
diff --git a/docs/tutorial/thumbnails.md → docs/tutorials/thumbnails.md b/docs/tutorial/thumbnails.md → docs/tutorials/thumbnails.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,10 +22,14 @@ theme:
     accent: blue
   features:
     - content.code.annotate
+    - navigation.tabs
 
 extra_css:
   - assets/theme.css
 
+watch:
+  - roblox
+
 plugins:
   - search
   - gen-files:
@@ -34,16 +38,13 @@ plugins:
   - literate-nav:
       nav_file: SUMMARY.md
   - mkdocstrings:
-      watch:
-        - roblox
       handlers:
         python:
           setup_commands:
           - import sys
           - sys.path.append("docs")
-          selection:
+          options:
             new_path_syntax: yes
-          rendering:
             show_if_no_docstring: yes
             show_signature_annotations: yes
             show_root_heading: yes