Update docs

vemel · Nov 15, 2023 · a0dc899 · a0dc899
1 parent e7feaaf
commit a0dc899
Show file tree

Hide file tree

Showing 20 changed files with 116 additions and 1,160 deletions.
diff --git a/.github/workflows/on_release_docs.yml b/.github/workflows/on_release_docs.yml
@@ -0,0 +1,74 @@
+name: Generate docs
+concurrency:
+  group: generate_docs
+  cancel-in-progress: true
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: {}
+
+jobs:
+  build-docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    env:
+      MAIN_BRANCH: main
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.MAIN_BRANCH }}
+      - name: Set up git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "github-actions"
+      - name: Create gh-pages branch if not exists
+        run: |
+          GIT_URL=`git config --get remote.origin.url`
+          GH_PAGES_BRANCH=`git ls-remote --heads ${GIT_URL} gh-pages`
+          if [[ "${GH_PAGES_BRANCH}" == "" ]]; then
+            echo "creating gh-pages branch"
+            git symbolic-ref HEAD refs/heads/gh-pages
+            rm .git/index
+            git clean -fdx
+            echo "Placeholder" > index.html
+            git add .
+            git commit -am "First pages commit"
+            git push origin gh-pages
+            echo "gh-pages branch created"
+            git checkout ${MAIN_BRANCH}
+          fi
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install project
+        run: |
+          python -m pip install poetry pip
+          poetry config virtualenvs.create false
+          poetry install -n
+      - name: Install handsdown
+        run: |
+          python -m pip install -U handsdown mkdocs mkdocs-material
+      - name: Build docs
+        run: |
+          python -m handsdown --external `git config --get remote.origin.url` -o docsmd --cleanup --panic --theme material --branch main $@
+          rm -rf docs/*
+          python -m mkdocs build
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          path: ./gh-pages
+          fetch-depth: 0
+      - name: Commit changes
+        run: |
+          cd ./gh-pages
+          rm -rf docs docsmd || true
+          mv ../docs .
+          mv ../docsmd .
+          git add docs
+          git add docsmd
+          git commit -am "Update docs"
+          git push
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # NewVersion - PEP 440 version manager
 
 [![PyPI - newversion](https://img.shields.io/pypi/v/newversion.svg?color=blue&label=newversion)](https://pypi.org/project/newversion)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/newversion.svg?color=blue)](https://pypi.org/project/newversion)
+[![PyPI - Downloads](https://static.pepy.tech/badge/newversion)](https://pepy.tech/project/newversion)
 [![Docs](https://img.shields.io/readthedocs/newversion.svg?color=blue&label=Builder%20docs)](https://newversion.readthedocs.io/)
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/newversion.svg?color=blue)](https://pypi.org/project/newversion)

diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/newversion/cli_parser.md b/docs/newversion/cli_parser.md
diff --git a/docs/newversion/constants.md b/docs/newversion/constants.md
diff --git a/docs/newversion/eol_fixer.md b/docs/newversion/eol_fixer.md