Update the repo to use Poetry build process

This commit is contained in:
madhead 2023-06-11 18:54:04 +02:00
parent 920574f8d8
commit 5ef3ce715a
No known key found for this signature in database
GPG Key ID: ACED25F067D0F238
2 changed files with 20 additions and 23 deletions

View File

@ -10,19 +10,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs markdown-callouts mkdocs-autorefs mkdocs-include-dir-to-nav mkdocs-material pymdown-extensions
- name: Install Poetry
uses: abatilo/actions-poetry@v2
- name: Build
run: mkdocs build
run: poetry run mkdocs build
- name: Publish
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: site
publish_branch: site

View File

@ -1,25 +1,20 @@
# docs
It is documentation repository for the projects of [InsanusMokrassar](https://github.com/InsanusMokrassar). In case you wish to interact with that lib localy, you will need to install dependnecies and mkdocs:
It is a documentation repository for the projects of [InsanusMokrassar](https://github.com/InsanusMokrassar).
## Running locally
For the ease of dependencies management, this repository uses [Poetry](https://python-poetry.org), a Python project & dependencies manager.
In case you wish to interact with these docs locally, make sure to [install](https://python-poetry.org/docs/#installation) it first.
In `Fleet` you may use [these configs](https://github.com/InsanusMokrassar/docs/blob/master/.fleet/run.json) to work with the repo.
To build or run it in vanilla terminal, use the following commands:
```bash
pip install mkdocs markdown-callouts mkdocs-autorefs mkdocs-include-dir-to-nav mkdocs-material pymdown-extensions
poetry run mkdocs build # Just build the site
```
**The snippet above can be outdated. See [publish workflow](https://github.com/InsanusMokrassar/docs/blob/master/.github/workflows/publish.yml) to be sure about building steps**
## Running and build
In `Fleet` you may use [these configs](https://github.com/InsanusMokrassar/docs/blob/master/.fleet/run.json). Localy there are several common options for build:
```bash
mkdocs build
poetry run mkdocs serve # Run a local server with the site
```
^ Will build mkdocs
```bash
mkdocs serve
```
^ Will continuously build __until first failure in build__