Added readthedocs stuff for API documentation. #21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also includes some type improvements to the docstrings of the code So the documentation is more helpful. Next step would be to go to https://app.readthedocs.org/dashboard/ and add the project. Then it should automatically host the docs for you
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added readthedocs stuff for API documentation, because this project lacks online API documentation.
This Pull Request at least gives you a base to continue to work with. Most code is already showing, however some functions and stuff could use more documentation and/or examples.
Also includes some type improvements to the docstrings of the code so the documentation is more helpful.
And it includes a fix for the exit function, since that is always called when object is deleted, and if the port cannot be opened, then it tries to close stuff, but it fails
Next step would be to go to https://app.readthedocs.org/dashboard/ and add the project. Then it should automatically host the docs for you.