nalmadi / fix8

Fix8 (Fixate) is an Open-Source GUI Tool for Working with Eye Tracking Data in Reading Tasks.
Mozilla Public License 2.0
5 stars 0 forks source link

Initial Automated Docs Created #171

Closed brettmt13 closed 2 months ago

brettmt13 commented 2 months ago

Structure and code for automating the docs for Fix8. Goes through each source module and creates docs for each using the docstrings.

One thing I had to do in order for sphinx to reference paths correctly was to remove "from . import " and just change it to "import " for relative source files, like driftAlgorithms.py. I edited any necessary calls to these any libraries in the code as well, which can be seen in Fix8.py.

If this change is undesired let me know, I can try further to get rid of the "attempted relative import with no known parent package" error sphinx gives. I think it could have to do with the path being used in conf.py, but I don't see any issue in the change made.

To view the initial docs: fix8/docs/_build/html/index.html