Updated documentation (Closes #23) #32
Merged
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
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.
The documentation has been improved a bit, mainly triggered by issue #23 .
It has been integrated with parts of the README and the format has been better organized, even if there is still a lot to add/remove/update (see #27 ).
Some files of the pipeline itself needed some fixes at the level of their docstrings.
I also fixed the warnings that Travis CI was treating as errors, thus causing the CI to crash and not producing the documentation (I added a
--nowarnflag totravis-sphinxback when I set up the CI configuration - this has to be removed, in order to catch any warning or error created by developers updating the documentation with their additions and/or updates).