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

Generate Python docs with Sphinx and host on ReadTheDocs.io #1858

Closed
jackgerrits opened this issue May 1, 2019 · 1 comment
Closed

Generate Python docs with Sphinx and host on ReadTheDocs.io #1858

jackgerrits opened this issue May 1, 2019 · 1 comment
Assignees
Labels
Documentation Issue in samples or documentation Lang: Python

Comments

@jackgerrits
Copy link
Member

The python bindings are decently documented with doc strings. It would be useful to be able to access those in the normal python docs way.

ReadTheDocs.io and Sphinx seem to be the standard way.

@jackgerrits jackgerrits added Documentation Issue in samples or documentation Lang: Python labels May 1, 2019
@jackgerrits jackgerrits self-assigned this May 17, 2019
@jackgerrits
Copy link
Member Author

jackgerrits commented May 17, 2019

For the time being the docs will be hosted statically on github pages. Once the python module install story is improved we can revisit using ReadTheDocs as it seems to require installing the module before generating docs

The docs are now hosted here: https://vowpalwabbit.github.io/docs/vowpal_wabbit/python/build/html/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue in samples or documentation Lang: Python
Projects
None yet
Development

No branches or pull requests

1 participant