docs: Adds basic documentation using mkdocs #103
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #103 +/- ##
==========================================
+ Coverage 65.87% 72.00% +6.13%
==========================================
Files 3 8 +5
Lines 337 593 +256
==========================================
+ Hits 222 427 +205
- Misses 115 166 +51 ☔ View full report in Codecov by Sentry. |
|
No idea why |
ns-rse
force-pushed
the
ns-rse/mkdocs-website
branch
2 times, most recently
from
54c8822 to
127c163
Compare
I had an hour of work left and was unlikely to be able to concentrate deeply on work so used the time productively to knock up the documentation for AFMReader using [mkdocs](https://www.mkdocs.org/). Its pretty basic but once merged pushes to the `main` branch of files under `docs/` will trigger the documentation to be rebuilt. It includes the API docs auto-generated from docstrings and the ability to easily switch between versions. This is a prelude to switching TopoStats and [AFM-SPM.github.io](https://github.com/AFM-SPM/AFM-SPM.github.io) over to `mkdocs`.
ns-rse
force-pushed
the
ns-rse/mkdocs-website
branch
from
127c163 to
53902e0
Compare
…ithub.com/AFM-SPM/AFMReader into maxgamill-sheffield/ns-rse-docs-additions
…ithub.com/AFM-SPM/AFMReader into maxgamill-sheffield/ns-rse-docs-additions
I had an hour of work left and was unlikely to be able to concentrate deeply on work so used the time productively to knock up the documentation for AFMReader using [mkdocs](https://www.mkdocs.org/). Its pretty basic but once merged pushes to the `main` branch of files under `docs/` will trigger the documentation to be rebuilt. It includes the API docs auto-generated from docstrings and the ability to easily switch between versions. This is a prelude to switching TopoStats and [AFM-SPM.github.io](https://github.com/AFM-SPM/AFM-SPM.github.io) over to `mkdocs`.
ns-rse
force-pushed
the
ns-rse/mkdocs-website
branch
from
53902e0 to
746cb7f
Compare
1 task
|
Ready for review. Current pre-commit failure is not one we can get round I don't think as its a configuration option required for the rendering of the Mermaid diagram. |
MaxGamill-Sheffield
approved these changes
Jan 22, 2025
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.
I had an hour of work left and was unlikely to be able to concentrate deeply on work so used the time productively to
knock up the documentation for AFMReader using mkdocs.
Its pretty basic but once merged pushes to the
mainbranch of files underdocs/will trigger the documentation to berebuilt. It includes the API docs auto-generated from docstrings and the ability to easily switch between versions.
This is a prelude to switching TopoStats and AFM-SPM.github.io over to
mkdocs.If you want to test it out locally to see what it looks like...
...and check the output for the URL to view the site at locally.