search

nalmadi / fix8

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

Documentation #149

Closed nalmadi closed 1 month ago

nalmadi commented 5 months ago

Unless I missed it, you don't seem to have any docs, and this will be important going forward. The paper will be able to serve as documentation for a limited time, but as the package matures you will want to be able to keep the docs up to date, so it's not good to rely on the paper for that purpose. There are packages that can help you generate documentation automatically that you can investigate.

nalmadi commented 4 months ago

https://youtu.be/b4iFyrLQQh4?si=Y6PtFiFchlmkbmf1

brettmt13 commented 4 months ago

Here is the first couple of commits: #171

nalmadi commented 1 month ago

@najam-tariq how did you generate the API documentation page? What tool did you use? I plan to regenerate it, how can I do that on my own? Thanks!

najam-tariq commented 1 month ago

@najam-tariq how did you generate the API documentation page? What tool did you use? I plan to regenerate it, how can I do that on my own? Thanks!

Hi @nalmadi, I used a library called pdoc: https://pdoc.dev/

nalmadi commented 1 month ago

Edited the manual here: https://docs.google.com/document/d/14g-kQfCTfn-jabcN50_mCkjD39DFVtT_sLlosPTREzQ/edit?usp=sharing