Skip to content

Try to do some improvements in the docs. #137

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.

Sign up for GitHub

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

Open
radnvlad wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Try to do some improvements in the docs. #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65e7cd5
Small changes to the docs.
radnvlad Feb 25, 2026
acd6990
The .md file are build artefacts. They probably should not be checked…
radnvlad Feb 25, 2026
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ dist
*.pyc
__pycache__
site
.venv
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,9 +469,12 @@ directory:

### Build Docs

pip3 install mkdocs
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
pip install mkdocs
cd docs
./generate_docs.py
generate_docs.py
cd ..
mkdocs serve --dev-addr=0.0.0.0:8001

Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
_build
site
*.md
349 changes: 0 additions & 349 deletions docs/app_installed.md
View file
Open in desktop

This file was deleted.

Loading