update docs

avgcampos · Jan 9, 2024 · 4696e34 · 4696e34
1 parent 0c3e64e
commit 4696e34
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -30,6 +30,14 @@ jobs:
       - name: Run tests
         run: make test
 
+      #----------------------------------------------
+      # publish docs
+      #----------------------------------------------
+      - name: Publish docs
+        run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files
+        run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
+        run: mkdocs gh-deploy
+
       - uses: actions/upload-artifact@v2
         with:
             name: code-coverage

diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,7 @@
 
 ![myfempy_logo](figures\logo.png)
 
-# Welcome to myfempy\'s online documentation!
+# Welcome to myfempy's online documentation!
 
 Copyright © Antonio Vinicius G. Campos 2022. Processo INPI BR512022001484-0