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

Script to generate API documentation #139

Merged
merged 7 commits into from
Jun 29, 2016

Conversation

Caylo
Copy link
Contributor

@Caylo Caylo commented Aug 6, 2015

Also includes the generated docs. The API docs use automodule which means they will always be built from the last released version.

For prettifying, some things in the docstrings will have to be changed, e.g @param and @author tags

For author tags, use field lists (:author: Name, see http://sphinx-doc.org/markup/misc.html#file-wide-metadata)

See also: http://sphinx-doc.org/domains.html#the-python-domain (especially the "into fields list" section)

minor tweaks to gen_api_docs.py script, add sphinx.ext.autodoc in conf.py
@boegel
Copy link
Member

boegel commented Jun 29, 2016

good to go, thanks @Caylo!

@boegel boegel added this to the v2.9.0 milestone Jun 29, 2016
@boegel boegel merged commit b472661 into easybuilders:develop Jun 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants