Skip to content

docs: Adds basic documentation using mkdocs#103

Merged
ns-rse merged 10 commits intomainfrom
ns-rse/mkdocs-website
Jan 22, 2025
Merged

docs: Adds basic documentation using mkdocs#103
ns-rse merged 10 commits intomainfrom
ns-rse/mkdocs-website

Conversation

@ns-rse
Copy link
Copy Markdown
Collaborator

@ns-rse ns-rse commented Jan 21, 2025

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 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 over to
mkdocs.

If you want to test it out locally to see what it looks like...

git pull
git switch ns-rse/mkdocs-website
pip install -e .[docs]
mkdocs serve

...and check the output for the URL to view the site at locally.

@ns-rse ns-rse added the documentation Improvements or additions to documentation label Jan 21, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.00%. Comparing base (f282c31) to head (a01e030).
Report is 227 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@ns-rse
Copy link
Copy Markdown
Collaborator Author

ns-rse commented Jan 21, 2025

No idea why markdownlint-cli2 is reporting these issues, the links are specified in a valid manner.

@ns-rse ns-rse force-pushed the ns-rse/mkdocs-website branch 2 times, most recently from 54c8822 to 127c163 Compare January 22, 2025 10:00
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 ns-rse force-pushed the ns-rse/mkdocs-website branch from 127c163 to 53902e0 Compare January 22, 2025 10:01
Max Gamill and others added 7 commits January 22, 2025 10:49
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
Copy link
Copy Markdown
Collaborator Author

ns-rse commented Jan 22, 2025

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.

@ns-rse ns-rse requested a review from Max-Gamill January 22, 2025 13:28
Copy link
Copy Markdown
Collaborator

@Max-Gamill Max-Gamill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep looks good! Thanks for including my edits :)

@ns-rse ns-rse merged commit 8e28542 into main Jan 22, 2025
@ns-rse ns-rse deleted the ns-rse/mkdocs-website branch January 22, 2025 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants