Skip to content

Make mkdocs documentation for powerfit#102

Merged
AnnaEngel98 merged 14 commits intomasterfrom
mkdocs
Jan 28, 2026
Merged

Make mkdocs documentation for powerfit#102
AnnaEngel98 merged 14 commits intomasterfrom
mkdocs

Conversation

@AnnaEngel98
Copy link
Contributor

No description provided.

@AnnaEngel98 AnnaEngel98 changed the title setup for mkdocs Make mkdocs documentation for powerift Jan 14, 2026
@AnnaEngel98 AnnaEngel98 changed the title Make mkdocs documentation for powerift Make mkdocs documentation for powerfit Jan 14, 2026
@codacy-production
Copy link

codacy-production bot commented Jan 14, 2026

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) 0.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (047844f) 1975 519 26.28%
Head commit (bf998b2) 1975 (+0) 519 (+0) 26.28% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#102) 1 0 0.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@AnnaEngel98 AnnaEngel98 linked an issue Jan 16, 2026 that may be closed by this pull request
@AnnaEngel98
Copy link
Contributor Author

Documentation for Powerfit using mkdocs finished. Only thing remaining is cli.md using mkdocs-rich-argparse which depends on i-VRESSE/mkdocs_rich_argparse#6

Copy link
Collaborator

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

Great work.

I have some suggestions on how to chop up the README.

sverhoeven
sverhoeven previously approved these changes Jan 28, 2026
Copy link
Collaborator

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

Looks good.

Just one correction rendering screenshot on https://pypi.org/project/powerfit-em/

Co-authored-by: Stefan Verhoeven <s.verhoeven@esciencecenter.nl>
@AnnaEngel98 AnnaEngel98 marked this pull request as ready for review January 28, 2026 12:21
@AnnaEngel98 AnnaEngel98 merged commit 6094a4b into master Jan 28, 2026
9 checks passed
@AnnaEngel98 AnnaEngel98 deleted the mkdocs branch January 28, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tutorial / user documentation

2 participants