doc: update doc and github action

OpenBMB · Jul 9, 2024 · 7779071 · 7779071
1 parent b9ea0dd
commit 7779071
Show file tree

Hide file tree

Showing 150 changed files with 914 additions and 21,127 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,35 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx furo
+    - name: Build HTML
+      run: |
+        make html -e
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html
+
+
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_images/.DS_Store b/docs/_images/.DS_Store
diff --git a/docs/_images/image.png b/docs/_images/image.png
diff --git a/docs/_images/server-client.jpg b/docs/_images/server-client.jpg
diff --git a/docs/_images/server.png b/docs/_images/server.png
diff --git a/docs/_sources/case/IOA.rst.txt b/docs/_sources/case/IOA.rst.txt
diff --git a/docs/_sources/distributed_service/config.rst.txt b/docs/_sources/distributed_service/config.rst.txt
diff --git a/docs/_sources/getting_started/installation.rst.txt b/docs/_sources/getting_started/installation.rst.txt
diff --git a/docs/_sources/high_level_concepts/code_structure.rst.txt b/docs/_sources/high_level_concepts/code_structure.rst.txt
diff --git a/docs/_sources/high_level_concepts/framework.rst.txt b/docs/_sources/high_level_concepts/framework.rst.txt