chore: Redesign docs

Author: onefloid

.github/workflows/docs.yml

@@ -0,0 +1,63 @@
+name: Build and Deploy Docs
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - "[0-9]+.[0-9]+.?[0-9]*" # Triggered by versions tags e.g. 2.0 or 2.0.1
+  workflow_dispatch: # Manually triggered
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements-docs.txt
+          pip install .
+
+      - name: Configure Git (for mike commits)
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Fetch gh-pages branch (if exists)
+        run: git fetch origin gh-pages:gh-pages || echo "gh-pages does not exist yet"
+
+      - name: Deploy documentation
+        run: |
+          if [[ "${GITHUB_REF}" == refs/heads/master ]]; then
+            echo "→ Deploying latest"
+            mike deploy latest --push --update-aliases
+            mike set-default latest --push
+          elif [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            VERSION="${GITHUB_REF#refs/tags/}"
+            echo "→ Deploying version $VERSION"
+            mike deploy "$VERSION" --push --update-aliases
+            mike set-default --push stable
+          fi
+
+      - name: Copy and commit CNAME file (if exists)
+        run: |
+          git checkout gh-pages
+          if git checkout master -- docs/CNAME 2>/dev/null; then
+            mv docs/CNAME .
+            git add CNAME
+            if ! git diff --cached --quiet; then
+              git commit -m "Update CNAME file"
+              git push origin gh-pages
+            else
+              echo "No changes to commit for CNAME"
+            fi
+          else
+            echo "No CNAME file found in master branch"
+          fi

.readthedocs.yml

@@ -1,7 +1,6 @@
 <h1 align="center">
 <img src="https://s3-ap-southeast-2.amazonaws.com/downloads.cubewise.com/web_assets/CubewiseLogos/TM1py-logo.png" style="width: 70%; height: 70%;text-align: center"/>
 
-
 ![PyPI - License](https://img.shields.io/pypi/l/TM1py)
 ![PyPI - Version](https://img.shields.io/pypi/v/TM1py)
 ![Pepy Total Downloads](https://img.shields.io/pepy/dt/TM1py)
@@ -31,17 +30,14 @@ TM1py offers handy features to interact with TM1 from Python, such as
 Requirements
 =======================
 
-- python (3.7 or higher)
-- requests
-- requests_negotiate_sspi
-- TM1 11, TM1 12
-- keyring
-
+- [Python](https://www.python.org/downloads/) (3.7 or higher)
+- [TM1/Planning Analytics](https://www.ibm.com/products/planning-analytics) (v11 or higher)
 
-Optional Requirements
+Optional Python Packages
 =======================
 
 - pandas
+- networkx
 
 Install
 =======================
@@ -53,10 +49,6 @@ Install
 > with pandas
 
     pip install "tm1py[pandas]"
-    
-> keyring
-
-    pip install keyring
 
 Usage
 =======================
@@ -84,7 +76,6 @@ with TM1Service(
     print(tm1.server.get_product_version())
 ```
 
-
 > TM1 12 PAaaS
 
 ``` python
@@ -134,19 +125,16 @@ with TM1Service(**params) as tm1:
     print(tm1.server.get_product_version())
 ```
 
-
 Documentation
 =======================
 
-https://tm1py.readthedocs.io/en/master/
-
+<https://tm1py.org/>
 
 Issues
 =======================
 
 If you find issues, sign up in GitHub and open an Issue in this repository
 
-
 Contribution
 =======================
 

README.md

@@ -0,0 +1 @@
+tm1py.org