Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-Generate API Docs (Starter) #11

Open
thomasjohns opened this issue May 7, 2019 · 1 comment
Open

Auto-Generate API Docs (Starter) #11

thomasjohns opened this issue May 7, 2019 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@thomasjohns
Copy link
Contributor

We'd likely want to use sphinx.

For this issue, the scope is to document fables.detect() and fables.parse() and have that documentation automatically build into an html page.

@thomasjohns thomasjohns added help wanted Extra attention is needed and removed help wanted Extra attention is needed labels May 7, 2019
@nfmcclure
Copy link
Contributor

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants