Set up aquapointer docs

[Misty-W]

Fixes #4

• Add files generated from Sphinx quickstart
• Create apidoc.rst
• Setup Read the Docs

[Misty-W]

@FarLab and @nathanshammah I started this PR for the initial documentation setup.

✅ I can get minimal docs to build locally --> looks like the Sphinx quickstart worked.
❌ Haven't yet figured out what's causing the warnings on each entry in the API-doc,

WARNING: autodoc: failed to import module 'aquapointer'; the following exception was raised:
No module named 'aquapointer.analog'

I'll come back to this after I try the RTD setup flow.

[Misty-W]

Also set up https://readthedocs.org/projects/aquapointer/ and added a .readthedocs.yaml file.
@nathanshammah I added you as a maintainer on RTD.
@FarLab, can you create a Read the Docs (RTD) account connected with your GitHub account? Then I can add you as a maintainer.
RTD is failing even after the addition of the associated yaml- maybe I missed modifying something in the template, or maybe something is off about conf.py.

[FarLab]

@Misty-W Just created a RTD account (username: farlab) and connected it with my github account!

[Misty-W]

Functions are showing up in API-doc now 🥳 . Rendering could be better- maybe a similar styling to what we have in Mitiq would be nice.

Also, I'm almost certain the RTD failure is due to RTD looking at main which of course doesn't have an RTD yaml file, whereas this PR does. Should "fix itself" upon merging. Eventually might want to preview RTD on PRs but that could probably wait in favor of other

[nathanshammah]

Great @Misty-W! I still cannot generate them with sphinx-build -b html source build. Is this what you're using?

[Misty-W]

Great @Misty-W! I still cannot generate them with sphinx-build -b html source build. Is this what you're using?

@nathanshammah I'm using make html.

[nathanshammah]

Mmh, strange, I get this message, even if I installed aquapointer with pip install -e . (v.0.0.2):

WARNING: Failed to import aquapointer.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.analog.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.analog.analog.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.analog.density_mapping.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.analog.qubo_solution.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.analog_digital.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.digital.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
WARNING: Failed to import aquapointer.slicing.
Possible hints:
* KeyError: 'aquapointer'
* ModuleNotFoundError: No module named 'scipy'
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] apidoc
WARNING: autodoc: failed to import module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'analog' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'analog.analog' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'analog.density_mapping' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'analog.qubo_solution' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'analog_digital' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'digital' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import module 'slicing' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import class 'density_canvas' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'
WARNING: autodoc: failed to import class 'analog_digital.processor' from module 'aquapointer'; the following exception was raised:
No module named 'scipy'

[Misty-W]

@nathanshammah I think pip install -e ".[development]" based on my testing with @FarLab running pip install requirements.txt should resolve the environment issues.

@FarLab, are you able to build and open the docs from this branch locally?

[FarLab]

LGTM