Update docs

fmtree-dev · Oct 29, 2023 · 4d020d9 · 4d020d9
1 parent 612e53c
commit 4d020d9
Show file tree

Hide file tree

Showing 120 changed files with 61 additions and 25,803 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -31,13 +31,27 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Build Docs
+        run: |
+          cd docs
+          rm -rf code-doc && sphinx-apidoc -o source/code-doc ../fmtree
+          make html
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
           # Upload entire repository
-          path: './docs'
+          path: './docs/build/html'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
diff --git a/README.md b/README.md
@@ -194,7 +194,7 @@ python -m fmtree.image.dup ~/Downloads/images --output_dir ./out --remove_inplac
 https://fmtree-dev.github.io/fmtree/
 
 ```bash
-sphinx-build -b html build-docs/source docs 
+sphinx-build -b html docs/source docs 
 ```
 
 This command will generate docs in `docs` folder, push it and the content will be deployed to GitHub Pages.
diff --git a/docs/.buildinfo b/docs/.buildinfo
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/fmtree.core.doctree b/docs/.doctrees/fmtree.core.doctree
diff --git a/docs/.doctrees/fmtree.doctree b/docs/.doctrees/fmtree.doctree
diff --git a/docs/.doctrees/fmtree.visualizer.doctree b/docs/.doctrees/fmtree.visualizer.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.doctrees/sample.doctree b/docs/.doctrees/sample.doctree
diff --git a/docs/.doctrees/tests.doctree b/docs/.doctrees/tests.doctree
diff --git a/build-docs/Makefile → docs/Makefile b/build-docs/Makefile → docs/Makefile
diff --git a/docs/_sources/fmtree.core.rst.txt b/docs/_sources/fmtree.core.rst.txt
diff --git a/docs/_sources/fmtree.rst.txt b/docs/_sources/fmtree.rst.txt
diff --git a/docs/_sources/fmtree.visualizer.rst.txt b/docs/_sources/fmtree.visualizer.rst.txt
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
diff --git a/docs/_sources/sample.rst.txt b/docs/_sources/sample.rst.txt
diff --git a/docs/_sources/tests.rst.txt b/docs/_sources/tests.rst.txt
diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js