Skip to content

Add MkDocs documentation site#107

Merged
egrace479 merged 14 commits intomainfrom
add-mkdocs
Oct 1, 2025
Merged

Add MkDocs documentation site#107
egrace479 merged 14 commits intomainfrom
add-mkdocs

Conversation

@egrace479
Copy link
Member

This PR implements the changes that have been worked out in this private repo to establish a site for the package documentation and explanations of the processes completed with it.

This includes updates to test workflows so that they only run when they or the relevant files are updated. All notebooks have been added into the docs/ folder to be rendered on the site. All images have also been moved to docs/images/, with references adjusted accordingly.

Still to do before the v3.0.0 release:

  • Update the Citation
  • Version increment (in citation, .zenodo.json, src/kabr_tools/__about__.py)
  • Ensure all links are working and pointed at the appropriate locations.
  • See cleanup/refinement notes here.

This PR will be a co-author commit squash merge (with @egrace479, @thompsonmj, @jennamk14).

@egrace479 egrace479 requested a review from thompsonmj October 1, 2025 17:40
@egrace479 egrace479 added design UX or presentation needs attention documentation Improvements or additions to documentation structure Refactoring or architecture, general code organization labels Oct 1, 2025
@egrace479 egrace479 marked this pull request as draft October 1, 2025 17:41
@thompsonmj thompsonmj marked this pull request as ready for review October 1, 2025 22:19
@egrace479 egrace479 merged commit 3aea1f2 into main Oct 1, 2025
3 checks passed
github-actions bot added a commit that referenced this pull request Oct 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

design UX or presentation needs attention documentation Improvements or additions to documentation structure Refactoring or architecture, general code organization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants