Add better docstrings and move doc generation to Sphinx#105
Merged
jammons merged 4 commits intoslackapi:masterfrom Jul 7, 2016
Merged
Add better docstrings and move doc generation to Sphinx#105jammons merged 4 commits intoslackapi:masterfrom
jammons merged 4 commits intoslackapi:masterfrom
Conversation
| @@ -1,3 +1,7 @@ | |||
| The MIT License (MIT) | |||
|
|
|||
| Copyright (c) 2015 Slack Technologies, Inc | |||
added 3 commits
July 7, 2016 15:14
Goal of this commit was to lay some groundwork for continuing to add more robust docs. This should set us up to have more thorough docstring-based docs inside the code as well as to have better organized documentation around how to use this library and how to contribute.
docs/ seems to be the more standard naming convention for python projects. Also removed unused .rst file
Closed
c-goosen
pushed a commit
to c-goosen/python-slackclient
that referenced
this pull request
Jun 18, 2019
Add better docstrings and move doc generation to Sphinx
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 docstrings to most public methods and we should now be able to generate docs by using sphinx.
Also moved doc/ to docs/