docs: use sphinx for python + C++ documentation

[vishwa2710]

To play with this locally:

• make dev
• make build-documentation
• cd docs/_build
• python3 -m http.server 8000

Navigate to localhost:8000 on your machine (ensure that the port is being properly forwarded).

There are some known issues here:

• linking of images/files in the README.md are not being done properly as the file is being inherited in a different folder.

We are using breathe (https://breathe.readthedocs.io/en/latest/directives.html#doxygengroup) to import the doxygen XML file into sphinx. I had to clean up the XML file to remove unnecessary information like files, dirs etc. (Thus the python script)

We are using Sphinx-Immaterial for the theme + documentation: https://sphinx-immaterial.readthedocs.io/en/latest/index.html

A reference repo I have been using: https://github.com/mhostetter/galois/blob/main/docs/index.rst?plain=1
Which produces this page: https://galois.readthedocs.io/en/v0.3.6/api/

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1be8bfd) 85.77% compared to head (116fea2) 85.78%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #294      +/-   ##
==========================================
+ Coverage   85.77%   85.78%   +0.01%     
==========================================
  Files          71       71              
  Lines        6304     6310       +6     
==========================================
+ Hits         5407     5413       +6     
  Misses        897      897              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kyle-cochran]

Weird, the arguments for some functions are collapsed. Here, the State constructor shows ... for most inputs.

[vishwa2710]

@kyle-cochran I believe if you click on the function it enumerates them.

[apaletta3]

Dude this is seriously awesome!!

Drawing your attention to a couple things that don't work in case your missed them

• The dynamic title of the page seems to only work for the PythonAPI, not the CPP API
  
  

• For the cpp API, Access seems to be a "group" above all the other classes.

• The sidebar dropdown for both the cpp and python APIs both start fully expanded, I don't know if there's a setting to make them show up as collapsed as first, cause that would be easier to read.

[apaletta3]

Suggested change

	}
	}

end of file line