Skip to content

Commit

Permalink
Added all wiki articles to the documentation, changed the theme
Browse files Browse the repository at this point in the history
  • Loading branch information
trbKnl committed Sep 27, 2024
1 parent 56b7a44 commit 59d8b1a
Show file tree
Hide file tree
Showing 14 changed files with 871 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
pip install sphinx sphinx_rtd_theme myst_parser piccolo_theme
- name: Sphinx build
run: |
sphinx-build doc _build
Expand All @@ -31,4 +31,4 @@ jobs:
publish_branch: gh-pages-docs
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
force_orphan: true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
/coverage
/_build
/.venv
**/**/__pycache__

# production
/build
Expand Down
8 changes: 0 additions & 8 deletions doc/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/api.md → doc/source/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
```{eval-rst}
.. automodule:: port.platforms.chatgpt
:members:
```
```
7 changes: 7 additions & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
API Documentation
=============================

.. toctree::
:maxdepth: 3

api.md
Loading

0 comments on commit 59d8b1a

Please sign in to comment.