Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: automated sphinx documentation for python bindings #714

Merged
merged 93 commits into from
Apr 5, 2024

Conversation

JSeam2
Copy link
Collaborator

@JSeam2 JSeam2 commented Feb 13, 2024

Changes:

  1. Automated python bindings documentation for readthedocs.io
  2. Creates a branch and tag with the latest version.
  3. Updates documentation on python.rs with numpy docstring format.

IMPORTANT
Prior to merge please set RTDS_WEBHOOK_URL and RTDS_WEBHOOK_TOKEN in the project secrets. Otherwise, it will not build any documentation.

You can obtain this by going to readthedocs.io and registering for an account. After linking the project, you may obtain the values from Admin > Integrations > Github Incoming Webhook, the respective values would be found there.

On the github side, a webhook from Readthedocs should be set, however, we will need to override the push settings. In the repository itself go to Settings > Code and Automation > Webhooks > Select readthedocs.io > unselect pushes. Save the changes.

Screenshot 2024-04-04 at 05 10 01

Manual Setup Notes
Should Oauth permissioning be too invasive. A possible route is to setup manually. Select Import Project

Screenshot 2024-04-04 at 23 14 35

Then select import manually
Screenshot 2024-04-04 at 23 16 16

Furnish more details about the project
Screenshot 2024-04-04 at 23 17 12

You will be directed to the next page. Simply click finish.
Screenshot 2024-04-04 at 23 17 33

After which you will be directed to the dashboard. From here we want to setup github webhooks. Click on Admin.
Screenshot 2024-04-04 at 23 18 28

Then click on integrations

We want to use Github incoming webhooks. So if this option is already present, click Next.
Screenshot 2024-04-04 at 23 19 43

You will be provided with a url and secret. We want to store them as RTDS_WEBHOOK_URL and RTDS_WEBHOOK_TOKEN respectively.
Screenshot 2024-04-04 at 23 19 54

Go back to the github repository and click on settings.

We first want to setup the two env variables. Go to secrets and variables > actions, copy the two values into the following env variables. This is needed for github action to trigger the push event.

Screenshot 2024-04-04 at 23 26 46

Next, create a webhook on github end with the two values obtained. Select Let me select individual events. And then enable, Branch or tag creation, Branch or tag deletion, Pull requests
Screenshot 2024-04-04 at 23 24 22

After which the Github webhook should send a ping to readthedocs.io, if the connection is successful it would not throw an error.

alexander-camuto and others added 28 commits February 21, 2024 22:13
Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
JSeam2 and others added 24 commits April 4, 2024 01:33
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

* fix: cleanup

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* docs: readthedocs (#19)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: upgrade maturin to 1.5.1

* fix: upgrade maturin to 1.5.1 (#20)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use the right requirements

* fix: unify requirements file (#21)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add cmake and libclang to apt_packages

* fix: add apt-packages (#22)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: typo

* fix: clang instead of libsclang (#23)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: swap to netlify

* fix: swap to netlify (#24)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: try new approach for rtd

* fix: add python runtime for netlify (#25)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: move doc version updates to the bottom

* fix: test build step (#26)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use env.Var

* merge (#27)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: remove git merge conflicts

* Pydoc (#28)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add checkout step

* fix: add checkout (#29)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add write-all permissions

* fix: updates version in docs requirements

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: tagging (#30)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use envvar

* fix: use envvar (#31)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: merge

* fix: typo (#32)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: updates tagging

* fix: rename

* fix: updates (#33)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: commit step

* Pydoc (#34)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* ci: update version string in docs

* fix: cleanup

* Pydoc (#35)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

* fix: cleanup

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* ci: update version string in docs

* fix: tagging

* fix: do not push to main

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* docs: readthedocs (#19)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: upgrade maturin to 1.5.1

* fix: upgrade maturin to 1.5.1 (#20)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use the right requirements

* fix: unify requirements file (#21)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add cmake and libclang to apt_packages

* fix: add apt-packages (#22)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: typo

* fix: clang instead of libsclang (#23)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: swap to netlify

* fix: swap to netlify (#24)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: try new approach for rtd

* fix: add python runtime for netlify (#25)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: move doc version updates to the bottom

* fix: test build step (#26)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use env.Var

* merge (#27)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: remove git merge conflicts

* Pydoc (#28)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add checkout step

* fix: add checkout (#29)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: add write-all permissions

* fix: updates version in docs requirements

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: tagging (#30)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: use envvar

* fix: use envvar (#31)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: merge

* fix: typo (#32)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: updates tagging

* fix: rename

* fix: updates (#33)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* fix: commit step

* Pydoc (#34)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* ci: update version string in docs

* fix: cleanup

* Pydoc (#35)

* docs: sphinx

* fix: update requirements

* fix: remove 0x from example

* fix: update docs

* docs: sphinx (#17)

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>

* fix: install ezkl via maturin

* Update .readthedocs.yaml

* fix: readthedocs

* fix: upgrade maturin to 1.5.1

* fix: use the right requirements

* fix: add cmake and libclang to apt_packages

* fix: typo

* fix: hold stacked outputs in a separate map

* fix: swap to netlify

* fix: add python runtime

* fix: add clang and cmake

* fix: move to root

* fix: make commitment optional for backwards compat (zkonduit#762)

* fix: patch large batch ex (zkonduit#763)

* fix: try new approach for rtd

* fix: move doc version updates to the bottom

* fix: use env.Var

* fix: remove git merge conflicts

* fix: add checkout step

* fix: add write-all permissions

* fix: swap back to rtd

* fix: move version updates into tagging.yaml

* fix: use envvar

* fix: merge

* fix: updates tagging

* fix: rename

* fix: commit step

* fix: cleanup

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>

* ci: update version string in docs

* fix: tagging

* fix: do not push to main

* fix: create separate branch

---------

Co-authored-by: dante <45801863+alexander-camuto@users.noreply.github.com>
Co-authored-by: Ethan Cemer <tylercemer@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@JSeam2 JSeam2 marked this pull request as ready for review April 3, 2024 21:07
@alexander-camuto alexander-camuto merged commit 0943e53 into zkonduit:main Apr 5, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants