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

Feature Request - Documentation on Release #12

Closed
daryltucker opened this issue Aug 28, 2014 · 4 comments
Closed

Feature Request - Documentation on Release #12

daryltucker opened this issue Aug 28, 2014 · 4 comments

Comments

@daryltucker
Copy link

Would you mind providing the HTML docs that can be generated?

It'd be very nice in deciding whether or not this is a library with which I (or others) would like to work.

Thanks.

@fake-name
Copy link

I generated the docs, and stuck them in the wiki.

They really should be more available, or even in the repo, though.

@ztane
Copy link
Owner

ztane commented Dec 10, 2014

Now available in the repo, linked from readme.rst, and always available in pydoc.

@fake-name
Copy link

It might be a good idea to hook something like TravisCI into the system, to keep the docs up to date.

You can push build artifacts out of TravisCI at this point.

For that matter, unit testing would be nice too, though this library seems pretty stable at this point.

Realistically, as long as the docs are rebuilt when the codebase is updated, managing them manually will probably be completely sufficient.

@ztane
Copy link
Owner

ztane commented Dec 11, 2014

There is no such thing as stable for this, as the Python 3 is not rigorously tested in real use, and the Python 2 side had a serious bug lurking since the beginning of the commit history (#8); and every change how minuscule that is needs to be verified for both Python 2 and 3... In Python 3.4 at least it is possible to easily run doctests from extension modules.

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

No branches or pull requests

3 participants