diff --git a/.fleet/run.json b/.fleet/run.json index a013164..9406bcb 100644 --- a/.fleet/run.json +++ b/.fleet/run.json @@ -3,15 +3,14 @@ { "type": "command", "name": "Rebuild", - "program": "mkdocs", - "args": ["build"], + "program": "poetry", + "args": ["run", "mkdocs", "build"], }, { "type": "command", "name": "Serve", - "program": "mkdocs", - "args": ["serve"], + "program": "poetry", + "args": ["run", "mkdocs", "serve"], }, - ] -} \ No newline at end of file +} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f03f2b2..f5498df 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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 \ No newline at end of file + publish_branch: site diff --git a/README.md b/README.md index 4ef0e3b..8f90267 100644 --- a/README.md +++ b/README.md @@ -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__ diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c8e20e4 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,20 @@ +[tool.poetry] +name = "docs" +version = "1.0.0" +description = "Documentation for InsanusMokrassar's projects" +authors = ["InsanusMokrassar"] + +[tool.poetry.dependencies] +python = "3.8.10" +mkdocs = "^1.4.3" +markdown-callouts = "^0.3.0" +mkdocs-autorefs = "^0.4.1" +mkdocs-include-dir-to-nav = "^1.2.0" +mkdocs-material = "^9.1.15" +pymdown-extensions = "^10.0.1" + +[tool.poetry.dev-dependencies] + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api"