diff --git a/.github/workflows/dev-docs.yml b/.github/workflows/dev-docs.yml index 2ac795b1..cabb8c3a 100644 --- 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/mkdocs-material.git@8.0.0b2 - 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 index 15161c92..f2190752 100644 --- 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/mkdocs-material.git@8.0.0b2 - 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 index 42f33b7d..c0bab0d8 100644 --- 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/) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 349a43e4..3a232a66 100644 --- 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 b/docs/tutorials/authentication.md similarity index 100% rename from docs/tutorial/authentication.md rename to docs/tutorials/authentication.md diff --git a/docs/bases.md b/docs/tutorials/bases.md similarity index 100% rename from docs/bases.md rename to docs/tutorials/bases.md diff --git a/docs/tutorial/error-handling.md b/docs/tutorials/error-handling.md similarity index 100% rename from docs/tutorial/error-handling.md rename to docs/tutorials/error-handling.md diff --git a/docs/extensions.md b/docs/tutorials/extensions.md similarity index 100% rename from docs/extensions.md rename to docs/tutorials/extensions.md diff --git a/docs/tutorial/get-started.md b/docs/tutorials/get-started.md similarity index 100% rename from docs/tutorial/get-started.md rename to docs/tutorials/get-started.md diff --git a/docs/tutorial/index.md b/docs/tutorials/index.md similarity index 100% rename from docs/tutorial/index.md rename to docs/tutorials/index.md diff --git a/docs/migrating.md b/docs/tutorials/migrating.md similarity index 100% rename from docs/migrating.md rename to docs/tutorials/migrating.md diff --git a/docs/tutorial/pagination.md b/docs/tutorials/pagination.md similarity index 100% rename from docs/tutorial/pagination.md rename to docs/tutorials/pagination.md diff --git a/docs/roblosecurity.md b/docs/tutorials/roblosecurity.md similarity index 100% rename from docs/roblosecurity.md rename to docs/tutorials/roblosecurity.md diff --git a/docs/tutorial/thumbnails.md b/docs/tutorials/thumbnails.md similarity index 100% rename from docs/tutorial/thumbnails.md rename to docs/tutorials/thumbnails.md diff --git a/mkdocs.yml b/mkdocs.yml index d8072d47..208c96b3 100644 --- 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