Squashed commit of the following:

commit aaf91f2 Author: ian <[email protected]> Date: Wed Oct 16 21:05:33 2024 +0800 gh-pages branch for docs (Sai); Dvine one set empty commit 9385803 Merge: d5121e0 1532674 Author: ian <[email protected]> Date: Wed Oct 16 19:35:32 2024 +0800 Merge remote-tracking branch 'forked_repo/main' into dev_ian commit 1532674 Author: Sai Kiran Reddy Poreddy <[email protected]> Date: Wed Oct 16 15:09:10 2024 +0800 Remove html files commit 18aad45 Author: Sai Kiran Reddy Poreddy <[email protected]> Date: Wed Oct 16 15:07:27 2024 +0800 Ignore html files commit 6902e6f Author: Sai Kiran Reddy Poreddy <[email protected]> Date: Wed Oct 16 15:06:57 2024 +0800 Add clean option commit 034c4ab Author: Sai Kiran Reddy Poreddy <[email protected]> Date: Wed Oct 16 15:06:28 2024 +0800 Use sphinx_pyproject for config commit dd9b534 Author: Sai Kiran Reddy Poreddy <[email protected]> Date: Wed Oct 16 15:05:05 2024 +0800 commit to gh-pages commit d5121e0 Merge: c451e67 ad544de Author: ian <[email protected]> Date: Tue Oct 8 11:52:19 2024 +0800 Merge branch 'main' into dev_ian commit c451e67 Author: ian <[email protected]> Date: Tue Oct 8 11:17:54 2024 +0800 dvine: s_first can be in the middle! sim: sobol seq dvine: TSP with precedence constraints or clustered TSP cvine/rvine: min heap DataBiCop.sim: is_sobol DataVineCop.sim: is_sobol commit 11566f1 Merge: 9c26242 687c4bb Author: TYCheng <[email protected]> Date: Wed Sep 25 20:17:00 2024 +0800 Merge branch 'main' into dev_ian commit 9c26242 Author: TYCheng <[email protected]> Date: Wed Sep 25 20:14:05 2024 +0800 update source files commit db1fd00 Author: TYCheng <[email protected]> Date: Wed Sep 25 20:13:09 2024 +0800 Squashed commit of the following: commit 687c4bb Author: Tuoyuan Cheng <[email protected]> Date: Fri Aug 23 18:03:40 2024 +0800 sampling order (tpl_sim) and vcp_from_sim (#25) * Update python-package.yml util.__init__ : ref_count_hfunc() to greedily find tpl_sim with min hfunc calls vinecop._data_vcp : one visit() for both hfunc and hinv in sim vinecop._factory_vcp: code refactoring to include the above * pyproject.toml, stdtr/stdtrit, README drop torch dependency for user customization * Update .yml pytest ./tests matrix.os * README, test_vinecop * sampling order, simplified commit 7a713c2 Author: TYCheng <[email protected]> Date: Wed Sep 25 20:10:33 2024 +0800 _data_vcp: sim, is_antithetic commit a587c0a Author: TYCheng <[email protected]> Date: Wed Sep 25 20:04:51 2024 +0800 Squashed commit of the following: commit 687c4bb Author: Tuoyuan Cheng <[email protected]> Date: Fri Aug 23 18:03:40 2024 +0800 sampling order (tpl_sim) and vcp_from_sim (#25) * Update python-package.yml util.__init__ : ref_count_hfunc() to greedily find tpl_sim with min hfunc calls vinecop._data_vcp : one visit() for both hfunc and hinv in sim vinecop._factory_vcp: code refactoring to include the above * pyproject.toml, stdtr/stdtrit, README drop torch dependency for user customization * Update .yml pytest ./tests matrix.os * README, test_vinecop * sampling order, simplified commit b62dfa4 Author: ian <[email protected]> Date: Thu Aug 29 10:20:08 2024 +0800 _data_vcp: sim, antithetic variates commit 8acf040 Author: ian <[email protected]> Date: Fri Aug 23 17:48:18 2024 +0800 sampling order, simplified commit 25646ba Merge: ea8f5c1 ac42d78 Author: ian <[email protected]> Date: Fri Aug 23 17:46:32 2024 +0800 Merge branch 'main' into dev_ian commit ea8f5c1 Merge: c9559cf f932d88 Author: ian <[email protected]> Date: Wed Jul 17 23:03:29 2024 +0800 Merge branch 'main' into dev_ian commit c9559cf Author: ian <[email protected]> Date: Wed Jul 17 23:03:23 2024 +0800 README, test_vinecop commit 64ec149 Author: ian <[email protected]> Date: Tue Jul 16 11:30:55 2024 +0800 Update .yml pytest ./tests matrix.os commit 203dd87 Merge: 2576acc a8de187 Author: ian <[email protected]> Date: Tue Jul 16 11:30:38 2024 +0800 Merge branch 'main' into dev_ian commit 2576acc Author: ian <[email protected]> Date: Tue Jul 16 11:08:36 2024 +0800 pyproject.toml, stdtr/stdtrit, README drop torch dependency for user customization commit acfc50e Merge: 33022c0 20dece8 Author: ian <[email protected]> Date: Tue Jul 2 21:43:48 2024 +0800 Merge branch 'main' into dev_ian commit 33022c0 Author: ian <[email protected]> Date: Tue Jul 2 21:15:36 2024 +0800 v2024.7.0 util.__init__ : ref_count_hfunc() to greedily find tpl_sim with min hfunc calls vinecop._data_vcp : one visit() for both hfunc and hinv in sim vinecop._factory_vcp: code refactoring to include the above commit d203c34 Merge: 1d367d7 72a37a3 Author: ian <[email protected]> Date: Mon Jun 24 19:55:55 2024 +0800 Merge branch 'main' into dev_ian commit 1d367d7 Merge: b943dc0 057d3ef Author: ian <[email protected]> Date: Mon Jun 24 14:49:51 2024 +0800 Merge branch 'main' into dev_ian commit b943dc0 Author: Tuoyuan Cheng <[email protected]> Date: Mon Jun 24 14:42:01 2024 +0800 Update python-package.yml commit 48b0aab Author: Tuoyuan Cheng <[email protected]> Date: Mon Jun 24 14:39:30 2024 +0800 Update python-package.yml commit 4e87861 Author: ian <[email protected]> Date: Mon Jun 24 14:31:09 2024 +0800 Update python-package.yml
TY-Cheng · Oct 16, 2024 · 5f11433 · 5f11433
1 parent ad544de
commit 5f11433
Show file tree

Hide file tree

Showing 59 changed files with 113 additions and 14,844 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -2,19 +2,16 @@
 name: Deploy Docs
 
 on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
+  # Run static when Lint Pytest workflow completes
+  workflow_run:
+    workflows: [Lint Pytest]
+    types:
+      - completed
+
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
@@ -24,20 +21,36 @@ concurrency:
 jobs:
   # Single deploy job since we're just deploying
   deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+
     runs-on: ubuntu-latest
+    # Give commit access to the workflow
+    permissions:
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install sphinx sphinx-pyproject furo torch scipy numpy
+      # Build the docs using Sphinx
+      - name: Sphinx build
+        run: |
+          sphinx-apidoc -o docs torchvinecopulib/ --separate
+          sphinx-build docs docs/_build/html
+      # Deploy sphinx documentation and commit to gh-pages branch
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          # Upload entire repository
-          path: "./docs/_build/html"
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html
+          force_orphan: true
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,9 @@
 # manual
-!/docs/_build/html
 !/docs/index.rst
 /docs/*.rst
 /docs/Makefile
 /docs/_build/doctrees/
-/docs/conf.py
+/docs/_build/html
 /scratch
 scratch*.ipynb
 

diff --git a/README.md b/README.md
@@ -89,8 +89,6 @@ Visit the [`./examples/`](https://github.com/TY-Cheng/torchvinecopulib/tree/main
 
 - Or visit [html-preview.github.io](https://html-preview.github.io/?url=https%3A%2F%2Fgithub.com%2FTY-Cheng%2Ftorchvinecopulib%2Fblob%2Fmain%2Fdocs%2F_build%2Fhtml%2Findex.html)
 
-- Or (locally) visit the `./docs/_build/html` subfolder for static `html` made with `Sphinx`
-
 - Or build by yourself (need [`Sphinx`](https://github.com/sphinx-doc/sphinx), theme [`furo`](https://github.com/pradyunsg/furo) and [the GNU `make`](https://www.gnu.org/software/make/))
 
 ```bash

diff --git a/docs/Makefile b/docs/Makefile
@@ -14,6 +14,9 @@ help:
 
 .PHONY: help Makefile
 
+clean:
+	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O);
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
-Original file line number
+Diff line change
@@ Expand Up @@
     - Or visit [html-preview.github.io](https://html-preview.github.io/?url=https%3A%2F%2Fgithub.com%2FTY-Cheng%2Ftorchvinecopulib%2Fblob%2Fmain%2Fdocs%2F_build%2Fhtml%2Findex.html)
-    - Or (locally) visit the `./docs/_build/html` subfolder for static `html` made with `Sphinx`
     - Or build by yourself (need [`Sphinx`](https://github.com/sphinx-doc/sphinx), theme [`furo`](https://github.com/pradyunsg/furo) and [the GNU `make`](https://www.gnu.org/software/make/))
     ```bash
@@ Expand Down @@