You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For reference and getting started in the documentation, a user should (1) fork/clone the repository, (2) checkout the sphinx branch, (3) change directory to doc, (4) compile make-html: make clean html. Then the resulting html documentation can be found under doc/_build/html/index.html.
To then improve upon the documentation (fill it out more), one can then make changes to specific docstrings in the files and recompile the doc html (step 4 above). And iterate. Once someone has any edits they would like to see, feel free to create a PR! Thanks!
We'd likely want to use sphinx.
For this issue, the scope is to document
fables.detect()
andfables.parse()
and have that documentation automatically build into an html page.The text was updated successfully, but these errors were encountered: