-
Notifications
You must be signed in to change notification settings - Fork 143
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
IMPORTANT
Prior to merge please set
RTDS_WEBHOOK_URL
andRTDS_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.
Manual Setup Notes
Should Oauth permissioning be too invasive. A possible route is to setup manually. Select Import Project
Then select import manually
Furnish more details about the project
You will be directed to the next page. Simply click finish.
After which you will be directed to the dashboard. From here we want to setup github webhooks. Click on Admin.
Then click on integrations
We want to use Github incoming webhooks. So if this option is already present, click Next.
You will be provided with a url and secret. We want to store them as
RTDS_WEBHOOK_URL
andRTDS_WEBHOOK_TOKEN
respectively.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.
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
After which the Github webhook should send a ping to readthedocs.io, if the connection is successful it would not throw an error.