Test docs CI

[arnaucasau]

Summary

Added a test to build the documentation and upload it as part of CI as an artifact for PRs.

[guomanmin]

Hi @arnaucasau - thanks for opening this PR! Just have a few quick questions I have when you get a chance

• AFAIK pandoc is not a linter but a doc converstion tool, wondering why we configure pandoc to the linter?
• In the docs workflow there is a RuntimeWarning: You are using an unsupported version of pandoc (2.9.2.1). Wondering if that is intentional?

[arnaucasau]

Hi @guomanmin, thanks for reviewing the PR! In this pull request, I added a new job into the lint.yml to test the building of the documentation, and the reason we configure pandoc in that job is because it's a requirement for Sphinx. This will be useful in other PRs like this one where we are updating the ecosystem sphinx theme. As for the version of pandoc it's not a problem in this case :)

[virajvchaudhari]

Hi @guomanmin, thanks for reviewing the PR! In this pull request, I added a new job into the lint.yml to test the building of the documentation, and the reason we configure pandoc in that job is because it's a requirement for Sphinx. This will be useful in other PRs like this one where we are updating the ecosystem sphinx theme. As for the version of pandoc it's not a problem in this case :)

Hi @arnaucasau, as per the official sphinx documentation, pandoc doesn't seem to be a requirement for sphinx and sphinx-theme. Pandoc seems to be more suitable for document conversion. Can you try checking this without adding this dependency to see if that builds the documentation or this requirement is necessary for anything else?

[arnaucasau]

Of course @virajvchaudhari! I tried without adding the dependency and as you can see in the commit the test failed with the error:

Notebook error:
PandocMissing in how_tos/0_how_to_access_AWS_Braket_devices.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html

I have added again the package in the last commit.

[virajvchaudhari]

I see what's happening there. Thanks for the clarification @arnaucasau!

[arnaucasau]

Thanks for the approval @virajvchaudhari! Can you merge this PR please? I don't have write access :)