Repository navigation
how-to coverage, pycal theming, RFC citation audit - #62
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Documentation build overview
49 files changed ·
|
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
1 participant
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.
Wrote the how-to guides that were missing: scheduling, free/busy, contacts, push notifications, attachments, running the conversion functions standalone, logging, and a full sync-to-SQLite example. Filled out calendar management and task sync, which only covered part of the client before. Added reference pages for
constants,session, andconvert, none of which autodoc was pulling in despite being fully documented in source. Added a server-compatibility page collecting the Cyrus/Stalwart quirks that were scattered across how-to pages.explanation/design.rstgot a few "Why" sections it was missing: CONFERENCE/VCONFERENCE URI correlation, recurrence override patches comparing by value, participant address handling, alert trigger shape, Link conversion scope, recurrenceUNTILtime zones.Moved the docs site off the Sphinx theme's default colors onto pycal's own, light and dark. pycal.org is light-only, so I built the dark variant myself from the same palette. Split the navbar into sections with their own landing pages; it was dumping every page into one list that overflowed into a cutoff dropdown.
Hit a real bug of my own doing the color work: a stray
*/inside a CSS comment I wrote closed it early and broke parsing of everything after, including the whole light-mode block. Dark mode worked the whole time, which is why it took a while to find. Separately, pydata-sphinx-theme never syncsdata-themeto Bootstrap'sdata-bs-theme, so Bootstrap components stayed in light colors in dark mode regardless of the theme's own variables. Fixed with a script that mirrors the attribute.Added SEO metadata: canonical link, description, social preview image per page, using pycal's branding. A few pages' social cards were pulling garbled text, since the extension grabs whatever's first on the page instead of an explicit description. Gave those pages a real opening paragraph.
Moved
CHANGES.rsttodocs/changelog.rst. It had:rfc:/:class:roles GitHub's raw viewer can't render.Checked every
:rfc:role in the autodoc'd modules against the actual RFC text. Some had regressed to plain text, some should've been plain (private helpers autodoc skips) but had dead roles instead. Fixed both directions.get_jmap_client/get_async_jmap_clientwere silently dropping a caller's ownauthobject before it reached the client. Fixed on both clients, with a test on each.