Set up GitHub Pages and deploy the docs

[arnaucasau]

The project now has the workflows to deploy the documentation to a branch called gh-pages, but we need to perform the first deployment and set up the repo to use GitHub Pages by following these instructions. Once the GitHub Pages is set up please update the repo's About section to display the new link.

• Deployment to the gh-pages branch
• Set up GitHub Pages

Instructions

Warning

Before starting with the process, you need to add a new branch called gh-pages. This branch needs to have that name to ensure the workflows can deploy successfully. You can create it manually, or, in case you have the new workflows, it will be created automatically after the first deployment (Better option).

Once you have the branch gh-pages created, you can follow the following steps:

1. Navigate to your site's repository
2. Click Settings
3. Go to Pages
4. Select Deploy from a branch, under the Source section on Build and deployment
5. Select the gh-pages branch and the / (root) folder in the Branch section on Build and deployment

The default URL where you can find your site is https://qiskit-extensions.github.io/mthree

For further information, you can see the GitHub Pages Quickstart and Qiskit/ecosystem#578.

[mtreinish]

https://qiskit-extensions.github.io/mthree/