Merge pull request #58 from semiotic-ai/50-setup-automatic-documentat…

…ion-generation ci(mkdocs): removed old documents and add mkdocs base build
semiotic-ai · Feb 17, 2023 · db30582 · db30582
2 parents a5f290e + eaf5469
commit db30582
Show file tree

Hide file tree

Showing 16 changed files with 1,489 additions and 1,609 deletions.
diff --git a/.github/workflows/semver.yml b/.github/workflows/semver.yml
@@ -65,3 +65,34 @@ jobs:
         password: ${{ secrets.GITHUB_TOKEN }}
     - name: Print image url
       run: echo "Image pushed to ${{ steps.push-to-ghcr.outputs.registry-paths }}"
+
+  build_docs:
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.published == 'True'    
+    env:
+      # https://github.com/actions/runner-images/issues/6185
+      PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
+
+    permissions:
+      contents: write
+
+    steps:    
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: '1.2.2'
+
+      - name: Install dependencies
+        run: poetry install --only docs
+
+      - name: Build documents
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          poetry run mike deploy --rebase --update-aliases v${{ needs.release.outputs.published_version }} latest
+          poetry run mike set-default --push latest
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 [![Semantic Versioning](https://img.shields.io/badge/semver-2.0.0-green)](https://semver.org/spec/v2.0.0.html)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Docs](https://img.shields.io/github/actions/workflow/status/semiotic-ai/autoagora/semver.yml?label=docs)](https://semoitic-ai.github.io/autoagora/)
 
 # AutoAgora
 

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+--8<-- "README.md"
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/agents.rst b/docs/source/agents.rst
diff --git a/docs/source/bandit_scripts.rst b/docs/source/bandit_scripts.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/environments.rst b/docs/source/environments.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
diff --git a/docs/source/model_generation.rst b/docs/source/model_generation.rst
diff --git a/docs/source/price_multiplier.rst b/docs/source/price_multiplier.rst
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,52 @@
+# Project information
+site_name: AutoAgora
+site_url: https://semiotic-ai.github.io/autoagora/
+
+# Repository
+repo_name: semiotic-ai/autoagora
+repo_url: https://github.com/semiotic-ai/autoagora
+edit_uri: ""
+
+# Configuration
+theme: 
+  name: material
+  features:
+    - navigation.tabs
+    - toc.integrate
+  icon:
+    repo: fontawesome/brands/github
+  palette:
+    primary: teal
+    accent: purple
+
+plugins:
+- search
+- mkdocstrings:
+    default_handler: python
+    handlers:
+      python:
+        options:
+          docstring_section_style: list
+          members_order: source
+          show_root_heading: true
+          show_signature_annotations: true
+          heading_level: 3
+          filters: ["!_"]
+- mike
+
+# Customization
+extra:
+  version:
+    provider: mike
+    default: latest
+
+markdown_extensions:
+  - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+
+nav:
+  - Home : README.md