mkdocs (#70)

* removed req.txt * . * updated docs * removed sphinx
agential-ai · Apr 12, 2024 · 94ffed4 · 94ffed4
1 parent aaf3ad2
commit 94ffed4
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 556 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -16,15 +16,15 @@ on:
 
 env:
   POETRY_VERSION: "1.6.1"
-  SUPPORTED_PYTHON_VERSIONS: "3.9 3.10 3.11"
+  SUPPORTED_PYTHON_VERSIONS: "3.11"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.11"]
     steps:
     - uses: actions/checkout@v3
 

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -16,15 +16,15 @@ on:
 
 env:
   POETRY_VERSION: "1.6.1"
-  SUPPORTED_PYTHON_VERSIONS: "3.9 3.10 3.11"
+  SUPPORTED_PYTHON_VERSIONS: "3.11"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.11"]
     steps:
     - uses: actions/checkout@v3
 

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,35 +1,19 @@
-# Read the Docs configuration file for Sphinx projects
+# Read the Docs configuration file for MkDocs projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
 
-# Set the OS, Python version and other tools you might need
+# Set the version of Python and other tools you might need
 build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
 
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
+mkdocs:
+  configuration: docs/mkdocs.yml
 
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#   - pdf
-#   - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#     - requirements: docs/requirements.txt
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -48,10 +48,10 @@ conda --version
 Ensure you have `make`. if it's not installed on your computer, Please follow this [article](https://earthly.dev/blog/makefiles-on-windows/).
 
 
-Use the following command to create a conda environment `discussion-agents` with Python version 3.10.13. Any Python version above 3.9 is viable.
+Use the following command to create a conda environment `discussion-agents` with Python version 3.11.5. Any Python version above 3.11 is viable.
 
 ```
-conda create -n discussion-agents python=3.10.13
+conda create -n discussion-agents python=3.11.5
 ```
 
 Now activate the environment.

diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 PROFILE = default
 PROJECT_NAME = discussion-agents
 PYTHON_INTERPRETER = python
-PYTHON_VERSION = 3.10
+PYTHON_VERSION = 3.11
 POETRY_VERSION = 1.6.1
 
 ifeq (,$(shell which conda 2>/dev/null))

diff --git a/README.md b/README.md
@@ -70,7 +70,7 @@ Thought: Ramon Dekkers has been involved in controversies and crimes. I need to
     │   │
     │   └── utils                      <- Utility methods.
     │       
-    ├── docs                           <- A default Sphinx project; see sphinx-doc.org for details.
+    ├── docs                           <- An mkdocs project.
     │
     ├── models                         <- Trained and serialized models, model predictions,
     │                                          or model summaries.

diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -7,7 +7,7 @@ authors = ["Vincent Tu <tuvincent0106@gmail.com>"]
 name = "docs"
 version = "0.0.1"
 description = ""
-readme = "README.md"
+readme = "DOCS_README.md"
 
 [tool.poetry.dependencies]
 python = "^3.11"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,16 @@
+click==8.1.7 ; python_version >= "3.11" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.11" and python_version < "4.0" and platform_system == "Windows"
+ghp-import==2.1.0 ; python_version >= "3.11" and python_version < "4.0"
+jinja2==3.1.3 ; python_version >= "3.11" and python_version < "4.0"
+markdown==3.6 ; python_version >= "3.11" and python_version < "4.0"
+markupsafe==2.1.5 ; python_version >= "3.11" and python_version < "4.0"
+mergedeep==1.3.4 ; python_version >= "3.11" and python_version < "4.0"
+mkdocs==1.5.3 ; python_version >= "3.11" and python_version < "4.0"
+packaging==24.0 ; python_version >= "3.11" and python_version < "4.0"
+pathspec==0.12.1 ; python_version >= "3.11" and python_version < "4.0"
+platformdirs==4.2.0 ; python_version >= "3.11" and python_version < "4.0"
+python-dateutil==2.9.0.post0 ; python_version >= "3.11" and python_version < "4.0"
+pyyaml-env-tag==0.1 ; python_version >= "3.11" and python_version < "4.0"
+pyyaml==6.0.1 ; python_version >= "3.11" and python_version < "4.0"
+six==1.16.0 ; python_version >= "3.11" and python_version < "4.0"
+watchdog==4.0.0 ; python_version >= "3.11" and python_version < "4.0"