Added initial documentation

[kc611]

As titled.

This PR adds the initial documentation required for the project's 0.0.2 release.

[esc]

@kc611 it seems like auto doc feature isn't quite working on RTD yet:

[esc]

@kc611 it seems like auto doc feature isn't quite working on RTD yet:

Here is the log from rtd:

WARNING: autodoc: failed to import module 'core.datastructures.basic_block' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'
WARNING: autodoc: failed to import module 'core.datastructures.byte_flow' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'
WARNING: autodoc: failed to import module 'core.datastructures.flow_info' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'
WARNING: autodoc: failed to import module 'core.datastructures.scfg' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'
WARNING: autodoc: failed to import module 'rendering.rendering' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'
WARNING: autodoc: failed to import module 'core.transformations' from module 'numba_rvsdg'; the following exception was raised:
No module named 'numba_rvsdg'

[esc]

@kc611 I pushed commit 37517dc which fixes the autodoc issues on rtd:

[esc]

hmmmm, seems like something is still off withe the autodoc

[esc]

hmmmm, seems like something is still off withe the autodoc

Looks like an import issue due to a missing dependency.

WARNING: autodoc: failed to import module 'byte_flow' from module 'numba_rvsdg.core.datastructures'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'flow_info' from module 'numba_rvsdg.core.datastructures'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'scfg' from module 'numba_rvsdg.core.datastructures'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'rendering' from module 'numba_rvsdg.rendering'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'transformations' from module 'numba_rvsdg.core'; the following exception was raised:
No module named 'yaml'

[esc]

We should probably get warnings to fail the build..

[esc]

Looking at:

https://blog.readthedocs.com/migrate-configuration-v2/

we wil probably need to migrate to .readthedocs.yaml file anyway, that'll allow installing the project via pip and pyproject.toml to get the required dependencies.

[esc]

@kc611 I finished the .readthedocs.yaml in #70 -- it's now a single commit based ontop of the commits from this PR. The build issues are now resolved:

https://numba-rvsdg--70.org.readthedocs.build/en/70/reference/index.html