Repository navigation
build: use Makefile for generating, building, checking documentation, and running formatting - #78
Merged
Merged
Conversation
…nning formatting - Use uv for managing a Python virtual environment. - Update `pyproject.toml` to use distinct groups, and use compatible dependency versions. - Generate `.rst` stub files from source Python files with `make apidoc` - Use `make linkcheckbroken` to check links in documentation, then manually fixed broken links. - Remove unused theme files. - Added templates to generate the SPDX headers from sphinx-apidoc. - Added theme templates from icalendar.
stevepiercy
marked this pull request as draft
November 1, 2026 12:44
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Documentation build overview
53 files changed ·
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Member
Author
|
@SashankBhamidi I left a spelling error on purpose because I was unable to parse the meaning of the sentence. See https://github.com/PyCalendar/calendaring-jmap/actions/runs/41310760173/job/124860437075?pr=78#step:7:68 Can you push a commit to fix whatever you intended there? |
Member
Author
|
@SashankBhamidi do you want a separate |
Member
|
Already got one, tests.yml's "Check for a news fragment" job. Don't duplicate it, just wire make's target to call that same towncrier check so it's one source of truth. |
stevepiercy
changed the title
stevepiercy
marked this pull request as ready for review
November 1, 2026 21:40
- Change file permissions to execute on bash scripts - Use 4-space indentation for reStructuredText directives - Use `shell` for the generic lexer of terminal commands - Split tests into subsections for unit and integration tests - Add Vale usage - Add make targets for running various tests
Vale.Terms=NO and most of the project's vocab accept-list got dropped or left commented out when this branch's .vale.ini and accept.txt were rewritten, failing the Documentation CI job on real, pre-existing prose (async, docstrings, repo, and others). Restored the suppression and the words still in active use, plus uv and a scoped exception for the one sentence that deliberately spells "addon" wrong as a counter-example.
stevepiercy
commented
Nov 2, 2026
…ed base class, and vale review feedback
stevepiercy
commented
Nov 2, 2026
stevepiercy
left a comment
stevepiercy
left a comment
Member
Author
There was a problem hiding this comment.
All looks good. Just one question.
SashankBhamidi
approved these changes
Nov 2, 2026
SashankBhamidi
left a comment
SashankBhamidi
left a comment
Member
There was a problem hiding this comment.
Went through everything... caught and fixed a couple more things along the way.
Good to merge. Good work! Thank you!
SashankBhamidi
changed the title
stevepiercy
commented
Nov 2, 2026
stevepiercy
commented
Nov 2, 2026
stevepiercy
left a comment
stevepiercy
left a comment
Member
Author
There was a problem hiding this comment.
Approved! Merge away!
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
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.
Use Makefile for generating, building, checking documentation, and running formatting
pyproject.tomlto use distinct groups, and use compatible dependency versions..rststub files from source Python files withmake apidocmake linkcheckbrokento check links in documentation, then manually fixed broken links.Review fixes:
requestspip extra,integration.ymlnever migrated to uv, dropped-W, and a private base class leaking into the public reference docs.uv.lock.news/63fragment per behavior, matching contribute.rst's own rule.Contributes to #63.