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

Add automatic documentation deployment workflow #396

Merged
merged 1 commit into from
May 31, 2024

Conversation

king-p3nguin
Copy link
Contributor

@king-p3nguin king-p3nguin commented May 31, 2024

Resolve #385

The automatically deployed documentation is available at: https://king-p3nguin.github.io/Tangelo/

Settings for GitHub Pages is as follows:
image

(I am contributing to this project as a unitaryHACK participant)

@ValentinS4t1qbit
Copy link
Collaborator

@king-p3nguin Sorry for my ignorance: I forget whether the repo maintainers should create a gh-pages branch in order to follow your instructions and if yes, can I just create it from any other branch ? (e.g does it matter how it was created ?)

Sorry, Github's documentation on the matter is sending me on a journey through a number of pages without answering my question

@king-p3nguin
Copy link
Contributor Author

@ValentinS4t1qbit When I tried running this workflow on my fork, peaceiris/actions-gh-pages@v4 automatically created gh-pages branch, so I think maintainers do not need to create this branch manually.

@ValentinS4t1qbit
Copy link
Collaborator

ValentinS4t1qbit commented May 31, 2024

@ValentinS4t1qbit When I tried running this workflow on my fork, peaceiris/actions-gh-pages@v4 automatically created gh-pages branch, so I think maintainers do not need to create this branch manually.

@king-p3nguin I cannot select it like in your screenshot, the drop-down menu only offer existing branches. Maybe a better question is: why wouldn't we select main ? (I do not quite recall why the issue description stated gh-pages, maybe we did not quite get how to do this right).

@king-p3nguin
Copy link
Contributor Author

king-p3nguin commented May 31, 2024

@ValentinS4t1qbit
This workflow is not executed until the yaml file is pushed to the main branch, so the gh-pages branch has not been created yet. It should be created through the workflow as soon as this PR is merged.

I think the reason peaceiris/actions-gh-pages@v4 pushes documentation to the separate gh-pages branch instead of the main branch is to simplify the commit history. (If it is pushed to main, than the commit history of main branch will be like "PR merge commit -> new document push ->PR merge commit -> new document push ->")

@ValentinS4t1qbit
Copy link
Collaborator

@king-p3nguin Alright, I'll give it a shot. The finish line for the hack is closing the issue, it is ok it we somehow need two separate PRs for adjustments.

@ValentinS4t1qbit ValentinS4t1qbit merged commit 1931479 into sandbox-quantum:develop May 31, 2024
9 checks passed
ValentinS4t1qbit added a commit that referenced this pull request Jun 18, 2024
#397)

* Improving draw method: now works with strings for gate parameters (#391)
* Added support for multi-controlled gates on qiskit (MCRX, MCRY, MCRZ, MCPHASE) (#390)
* Add automated documentation workflow & gitignore (#396)
* Unitaryhack issue 386: Augment the Rotosolve optimizer to support Rotoselect (#392)
* ⚡Added rotoselect algorithm and improved rotosolve to use 2 evaluations per parameter.
* Unitaryhack issue 384: Circuit as reference state in the ansatz definition (#398)
* added method `Circuit.fix_variational_parametrs`, which turns all variational gates non-variational.
* Added support for circuits referrence states for the ansatze
* Fixing Pyscf Incompatibility problem  (#394)
* update CI to check for version 2.5
* Update mp2_solver.py

---------

Co-authored-by: AlexandreF-1qbit <76115575+AlexandreF-1qbit@users.noreply.github.com>
Co-authored-by: ValentinS4t1qbit <valentin@goodchemistry.gmail>
Co-authored-by: Alexandre Fleury <76115575+alexfleury-sb@users.noreply.github.com>
Co-authored-by: Valentin Senicourt <valentin.senicourt@1qbit.com>
Co-authored-by: GitHub Actions <noreply@github.com>
Co-authored-by: Anush Venkatakrishnan <54374648+anushkrishnav@users.noreply.github.com>
Co-authored-by: Or Golan <golanor@users.noreply.github.com>
Co-authored-by: Kazuki Tsuoka <kazukitsuoka@g.ecc.u-tokyo.ac.jp>
Co-authored-by: Colin Burdine <33066825+cburdine@users.noreply.github.com>
@king-p3nguin king-p3nguin deleted the develop branch September 10, 2024 10:48
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