Skip to content

Commit 39ccda1

Browse files
docs(markdown): migrate docs from rst to md (#422)
Migrated docs from `readthedocs.io` to `github.io`. --------- Co-authored-by: Artem Rys <rysartem@gmail.com>
1 parent c70b4bf commit 39ccda1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+665
-1473
lines changed

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
branches:
8+
- main
9+
10+
jobs:
11+
docs:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: write
15+
pages: write
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.8
21+
- run: |
22+
curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
23+
pip install mkdocs mkdocs-material mkdocstrings-python
24+
- name: Deploy to GitHub Pages
25+
if: github.ref_name == 'main'
26+
run: mkdocs gh-deploy --force --strict
27+
- name: Build Docs
28+
if: github.ref_name != 'main'
29+
run: mkdocs build --strict

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ celerybeat.pid
101101

102102
# Environments
103103
.env
104-
.venv
104+
# ignore all venv with different Py versions
105+
.venv*
105106
env/
106-
venv/
107107
ENV/
108108
env.bak/
109109
venv.bak/

.readthedocs.yml

Lines changed: 0 additions & 17 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 72 deletions

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/api_reference.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions

docs/api_reference/base_test.md

Lines changed: 3 additions & 0 deletions
Lines changed: 3 additions & 0 deletions
Lines changed: 3 additions & 0 deletions

0 commit comments

Comments
 (0)