-
Notifications
You must be signed in to change notification settings - Fork 136
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
Deploy docs to GitHub Pages #311
Conversation
Pull Request Test Coverage Report for Build 7615325851
💛 - Coveralls |
@arnaucasau With the deploy translatable strings script deleted I imagine the gettext section of the tox.ini file can be removed (the script used tox to do the strings). Also there is gettext config in the conf.py such as gettext_compact that is not really needed. While you are having locales folder there not cleaned during deploy it seems that any further updates of the translations are not going to happen - hence the removal of the script. I figured to sort things out here, since the other apps (Nature, ML and Opt) should be pretty much identical in regards this change. Once it all seems fine then backport this PR and deploy the docs to make sure its all as expected. |
Thank you @woodsp-ibm for your review! In the last commit, I removed the gettext section from the tox.ini and the config related to it that I found in I'll make the same changes to Nature, Machine learning, and Optimization 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arnaucasau Thanks for the changes. I labelled this so it will be backported to stable after which I will deploy the docs again so things can checked out as/if needed.
* Deploy docs to GitHub Pages * Fix conf.py copyrighht date * gettext removed --------- Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> (cherry picked from commit 7108f6a)
* Deploy docs to GitHub Pages * Fix conf.py copyrighht date * gettext removed --------- Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> (cherry picked from commit 7108f6a) Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Summary
This PR changes the
deploy-docs.yml
workflow to deploy the documentation to GitHub Pages to migrate the project away from the qiskit.org domain.The deployment to the
gh-pages
branch will not overwrite thelocale
folder, where I will save all the translations in a follow-up once the first deployment is done.More information about the change and a quick guide to set up GitHub pages can be found at: Qiskit/ecosystem#578
Reminder task for maintainers here to update the doc link in the About text for the repo on the main page once this change happens and the docs are re-deployed.