Development documentation and doc updates #79
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
n-claes
force-pushed
the
docs/devdocs
branch
5 times, most recently
from
c738b85
to
f8d6897
Compare
n-claes
force-pushed
the
docs/devdocs
branch
from
f8d6897
to
6cd24f7
Compare
Codecov Report
@@ Coverage Diff @@
## develop #79 +/- ##
===========================================
+ Coverage 86.88% 86.98% +0.10%
===========================================
Files 102 102
Lines 5885 5892 +7
===========================================
+ Hits 5113 5125 +12
+ Misses 772 767 -5
Flags with carried forward coverage won't be shown. Click here to find out more. |
n-claes
force-pushed
the
docs/devdocs
branch
from
81584e3
to
367dc8f
Compare
Merged
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.
PR description
Simplifies the contents of the
docsfolder and enables the use of development docs. The .yml is setup in such a way that doc generation happens on PRs to thedevelopbranch to check that compilation is successful, but actual deployment is only done on pushes. Doc generation is now done through use of a Python script.No need to check doc compilation on PRs to
master, we merge straight fromdevelopand it's checked there.Also updates the repository README's and adds some shields for clarity.