Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and workflows #91

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/dev-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 7 additions & 11 deletions .github/workflows/release-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 10 additions & 10 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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/)
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 5 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ theme:
accent: blue
features:
- content.code.annotate
- navigation.tabs

extra_css:
- assets/theme.css

watch:
- roblox

plugins:
- search
- gen-files:
Expand All @@ -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
Expand Down