Doc Build Warnings

[purva-thakre]

Description

Fixes #152

Todos

Notable points that this PR has either accomplished or will accomplish.

• TODO 1

Questions for the future

• It might be better to have a reference file labeled refs.bib instead of manually inserting a reference list in docstrings of functions.
• Why does a local make html add new files? Is there a way to build the documentation in a different way? Or should the instructions for contributors be updated that these files are to be ignored?
• Citation warnings in the docs build are not consistent. Sometimes [some_ref]_ gets flagged as reference not found but other times [some_ref_link] does not get flagged as an error. This should be made consistent.

Status

• Ready to go

[vprusso]

Thanks for the PR, @purva-thakre !

Looks like you're still working on this, but let me know when it's ready to go or when it's ready for review.

Good to see you here, and thank you, as always for your contributions!

[purva-thakre]

@vprusso All local make html errors in toqito\docs are fixed. This PR can be merged unless you come across some additional errors.

Feel free to ignore the Questions for the Future portion in the PR description.

Edit: Forgot the linked issue had some problems related to pytest --cov-report term-missing --cov=toqito tests/. I don't get the same errors this time. Perhaps these were fixed in another PR?

[vprusso]

Regarding this question here:

It might be better to have a reference file labeled refs.bib instead of manually inserting a reference list in docstrings of functions.

I completely agree. I actually quite like the way that say, mitiq handles references within the project and think this might be a good alternative for toqito. Perhaps we should spin up a separate issue for this as you're implicitly suggesting with the question section. What do you think?

EDIT: Scratch that, I see you've already done that here:
#191

Perfect!

[vprusso]

The PR itself looks good to me. Thank you again for your contribution, @purva-thakre !