mirror of
https://github.com/InsanusMokrassar/docs.git
synced 2024-11-22 08:13:59 +00:00
Update the repo to use Poetry build process
This commit is contained in:
parent
920574f8d8
commit
5ef3ce715a
14
.github/workflows/publish.yml
vendored
14
.github/workflows/publish.yml
vendored
@ -10,19 +10,21 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: Setup Python
|
- name: Setup Python
|
||||||
uses: actions/setup-python@v4
|
uses: actions/setup-python@v4
|
||||||
with:
|
with:
|
||||||
python-version: '3.10'
|
python-version: '3.10'
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
- name: Install Poetry
|
||||||
python -m pip install --upgrade pip
|
uses: abatilo/actions-poetry@v2
|
||||||
pip install mkdocs markdown-callouts mkdocs-autorefs mkdocs-include-dir-to-nav mkdocs-material pymdown-extensions
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: mkdocs build
|
run: poetry run mkdocs build
|
||||||
|
|
||||||
- name: Publish
|
- name: Publish
|
||||||
uses: peaceiris/actions-gh-pages@v3
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
with:
|
with:
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
publish_dir: ./site
|
publish_dir: ./site
|
||||||
publish_branch: site
|
publish_branch: site
|
||||||
|
29
README.md
29
README.md
@ -1,25 +1,20 @@
|
|||||||
# docs
|
# 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
|
```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
|
```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__
|
|
||||||
|
Loading…
Reference in New Issue
Block a user