States the outputs in the usage section#104
Merged
ns-rse merged 8 commits intons-rse/mkdocs-websitefrom Jan 22, 2025
Merged
Conversation
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`.
…ithub.com/AFM-SPM/AFMReader into maxgamill-sheffield/ns-rse-docs-additions
…ithub.com/AFM-SPM/AFMReader into maxgamill-sheffield/ns-rse-docs-additions
ns-rse
force-pushed
the
ns-rse/mkdocs-website
branch
from
53902e0 to
746cb7f
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Just a tiny bit of tidying to state what we output at the top of the usage section, and add "metadata" into the introduction.