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

Development documentation and doc updates #79

Merged
merged 24 commits into from
Oct 1, 2021
Merged

Development documentation and doc updates #79

merged 24 commits into from
Oct 1, 2021

Conversation

n-claes
Copy link
Owner

@n-claes n-claes commented Sep 22, 2021

PR description

Simplifies the contents of the docs folder and enables the use of development docs. The .yml is setup in such a way that doc generation happens on PRs to the develop branch 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 from develop and it's checked there.

Also updates the repository README's and adds some shields for clarity.

@n-claes n-claes added the docs Documentation related stuff label Sep 22, 2021
@n-claes n-claes added this to the v1.1 milestone Sep 22, 2021
@n-claes n-claes force-pushed the docs/devdocs branch 5 times, most recently from c738b85 to f8d6897 Compare September 22, 2021 15:08
@n-claes n-claes marked this pull request as ready for review September 23, 2021 11:28
@codecov
Copy link

codecov bot commented Sep 23, 2021

Codecov Report

Merging #79 (367dc8f) into develop (9beff37) will increase coverage by 0.10%.
The diff coverage is n/a.

@@             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     
Flag Coverage Δ
legolas 88.71% <ø> (-0.04%) ⬇️
pylbo 83.50% <ø> (+0.35%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@n-claes n-claes merged commit 18d7a47 into develop Oct 1, 2021
@n-claes n-claes deleted the docs/devdocs branch October 6, 2021 09:08
@n-claes n-claes mentioned this pull request Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related stuff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant