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

Building API Docs on RTD Fails For Unit Tests #9

Closed
lukearno opened this issue Nov 24, 2011 · 1 comment
Closed

Building API Docs on RTD Fails For Unit Tests #9

lukearno opened this issue Nov 24, 2011 · 1 comment

Comments

@lukearno
Copy link
Owner

I am not sure that I can build these docs on RTD when I am autodoc-ing the tests unless I properly install them. I don't think I want to A) make the test suite it's own package with it's own setup.py or B) make the tests an installed part of Selector. If there is some way to install the tests selectively, or some other way to get RTD to build them, that would be cool.

I am going to back off of this, for now, and keep the issue open. I want to treat the tests as first class code and document them in this way, but, until I figure out how, I am going to be pragmatic and at least build the selector module's public API docs in the mean time.

...OTOH, maybe should the API docs just be limited to the Public API that which I want to consider Selector's public API, WRT SemVer. I may potentially just choose to close this and leave it that way...

@lukearno
Copy link
Owner Author

I've decided to close this. Basic docs are building. I don't think tests were appropriate here anyway. Neither was fabfile and I removed that too. I think this should just be the Public API of Selector itself.

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

1 participant