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 documentation #277

Closed
osma opened this issue May 13, 2019 · 3 comments · Fixed by #280
Closed

Auto-generate API documentation #277

osma opened this issue May 13, 2019 · 3 comments · Fixed by #280
Assignees
Milestone

Comments

@osma
Copy link
Member

osma commented May 13, 2019

For users and especially developers getting familiar with the Annif codebase, it would help a lot to set up browsable API documentation generated using e.g. Sphinx. It could then be published on ReadTheDocs.

@osma
Copy link
Member Author

osma commented May 13, 2019

This PyCon 2018 talk by Carol Willing seems like a good introduction to the subject

Note that at this stage we would still keep the non-API documentation in the GitHub wiki.

@osma
Copy link
Member Author

osma commented May 13, 2019

Another tutorial that looks good https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/

@kinow
Copy link
Collaborator

kinow commented May 13, 2019

+1

We generate the API documentation with Sphinx, though not using readthedocs, but instead a github pages site. Then the generated API is included in the manual part of the site as a per-section doc, and as a single page. For that, we had to customize the setuptools integration a bit.

But the hard work had been done some time ago in putting a theme and structure in a conf.py settings file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants