Closed BSchilperoort closed 1 year ago
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
It's working perfectly locally, but ReadTheDocs is messing it up and adding the useless "Edit on Github" button instead of "view source"...
@BSchilperoort thank you for addressing issue #61 . Please use the new project logo in SharePoint, I will share the link in teams. I updated the github organization avatar.
Thanks for the review! I've updated the documentation, and removed the duplicate part from README.md.
Kudos, SonarCloud Quality Gate passed!
0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells
No Coverage information
0.0% Duplication
The "how to run the model" notebook is now included in the documentation. The "view source" of the notebook correctly links to the notebook which was used to build the documentation. If a user is viewing thestable
docs, the notebook + download link will properly reflect the version of the latest stable release.Additionally- Added logo to the docs- Restructured the table of contentsDocs are now built using mkdocs.
The notebooks have been moved to docs/notebooks. The instruction notebook is now visible on the mkdocs build. The notebooks visible on the documentation have a download button, which links to the ipynb file used to generate the docs.
Link to built docs
Closes #61
Note: The md link checker is failing due to the link being updated in the documentation, but not yet being available in
main