Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up documentation on read the docs #372

Merged
merged 8 commits into from
Sep 23, 2024
Merged

Conversation

hmpf
Copy link
Contributor

@hmpf hmpf commented Sep 13, 2024

Scope and purpose

Secures the zino namespace on read the docs.

Contributor Checklist

Every pull request should have this checklist filled out, no matter how small it is.
More information about contributing to Zino can be found in the
README.

  • Added a changelog fragment for towncrier
  • Added/amended tests for new/changed code

There are no code changes, hence no tests.

  • Added/changed documentation
  • Linted/formatted the code with black, ruff and isort, easiest by using pre-commit

There are no code changes, hence no linting.

  • The first line of the commit message continues the sentence "If applied, this commit will ...", starts with a capital letter, does not end with punctuation and is 50 characters or less long. See https://cbea.ms/git-commit/
  • If applicable: Created new issues if this PR does not fix the issue completely/there is further work to be done

@hmpf hmpf self-assigned this Sep 13, 2024
@hmpf
Copy link
Contributor Author

hmpf commented Sep 13, 2024

Black complains about "docs/conf.py" which is autogenerated.

Copy link

codecov bot commented Sep 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.66%. Comparing base (b19d9fa) to head (92a0727).
Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #372   +/-   ##
=======================================
  Coverage   98.66%   98.66%           
=======================================
  Files          77       77           
  Lines        9711     9711           
=======================================
  Hits         9581     9581           
  Misses        130      130           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

changelog.d/+add-docs-dir.added.md Outdated Show resolved Hide resolved
Copy link
Member

@lunkwill42 lunkwill42 left a comment

Choose a reason for hiding this comment

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

Looks decent, just nitpicking details :)

.readthedocs.yaml Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
hmpf and others added 3 commits September 19, 2024 11:44
Co-authored-by: Morten Brekkevold <[email protected]>
Co-authored-by: Morten Brekkevold <[email protected]>
Copy link

sonarcloud bot commented Sep 19, 2024

@lunkwill42 lunkwill42 merged commit 6dc98ef into Uninett:master Sep 23, 2024
10 checks passed
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.

3 participants