python-eel
Have a documentation page
I would like to have a website with proper documentation of how to use eel and what are the APIs available
We definitely should have something like this, you're right. I'll have a look into setting up some basic hosted docs that we can iterate on and build over time.
I am willing to participate in this work. After Christmas, I'll work on it personally and write a pull request.
Here's an approach that might work for this project:
I used pydoc-markdown to generate a markdown file:
- I cloned the Eel project
- in the project dir I created a doc dir
- cd to Eel/doc
- from the doc dir I ran
pydoc-markdown -I ../eel >README.mdthis generated a markdown file you could then link to as the documentation.
From here you could maintain the doc strings in the python files, and then just run command this as part of your "build" for each release
The markdown file I got wasn't great, but better than what we have, and with this process it cold improve with time.
At least this idea doesn't require any additional hosting, it's self contained within this github project, so I hope this is helpful :crossed_fingers:
