Create new documentation page

[Guillermo-Mijares-Vilarino]

Summary

This PR aims to create a separate documentation page for this repo.

Details and comments

• Change sphinx_rtd_theme to qiskit_sphinx_theme
• Add the tutorials to the sidebar.
• Use nbsphinx to render the tutorials.
• Create workflow for docs deployment to qiskit.org/ecosystem

TODO:

• Add rclone keys

[mtreinish]

Why not just put this in the reno configuration directly config?

[Guillermo-Mijares-Vilarino]

This is something I took from several of the applications repos (see these PRs on nature, optimization and machine learning).

However, I see that qiskit-aer and qiskit-dynamics don't include any reference to earliest_version (in neither their respective releasenotes/config.yaml nor the docs deployment workflow) and seem to work just fine.

Is it possible that earliest_version is something that was necessary 2 years ago (when the applications PRs were done) but not now? Maybe I can simply remove that line with no ill effects.

[Guillermo-Mijares-Vilarino]

I've just removed that line. Is there any way to test whether the deployment process would be successful @mtreinish?

[mtreinish]

There isn't really a test mechanism for the deployment process. We either publish it or not, the fundamental limitation comes from access to secrets, for security reasons the secrets aren't available to CI run from forks to limit access to only reviewed/merged code.

The only option to test this is post merge to click the button for the workflow dispatch in the UI. This is probably generally advisable anyway because there haven't really been any changes to the ibmq provider to trigger a release so we can just do a manual build from the stable branch.

[HuangJunye]

@1ucian0 Can you please assign me so that I can keep track of the PR review? Thanks!

[HuangJunye]

LGTM, but I can't test the deployment. @mtreinish Is there a way to test the deployment before merging? I think we add a temporary trigger for the deploy-docs workflow to be triggered on PR. The workflow requires secrets which I think will only work if we make a PR from a branch of the upstream repo instead of a fork. Should we do that here?

[mtreinish]

Overall this LGTM just a couple small things inline. Also it would be good while we're updating this to add -d {toxinidir}/docs/.doctrees to the tox command for the docs build so that we're not publishing the sphinx build cache to COS. This will make the upload faster, save bandwidth and disk space too.

[Guillermo-Mijares-Vilarino]

I've just added the -d {toxinidir}/docs/.doctrees to docs build and included the docs/.doctrees/ directory as part of .gitignore.

With this I believe all the comments are addressed.