I have been working on the design of lightsteem in the latest couple of weeks and I feel like the library is in a good state, so I have created a documentation for potential developers want to try the library.
It's online at https://lightsteem.readthedocs.io
Documentation Pages
I have used Sphinx and rtfd.org to write and host the documentation. All documentation files are stored at the /docs folder inside .RST formatted files.
Let me know you if you're interested in the library and feel like there are missing concepts.
Contributing to the documentation
- Fork the repository
- Create a new branch. Eg: (typo-fix)
- Install sphinx sphinx-autobuild packages on your virtual environment.
- Run
sphinx-autobuild docs docs/_build/html --port=8001. This command will serve the documentation on http://localhost:8001. - Make changes you want on .RST files.
- Create a pull request