Documentation updates for version 1.28.0#5008
Draft
jamie-lemon wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx documentation to reflect v1.28.0 additions around Markdown support and CSS styling, and to centralize / cross-link conversion and styling guidance across the docs.
Changes:
- Adds documentation for Markdown-related workflows (Markdown → PDF, CSS styling via
apply_css,archiveusage). - Adds a new “CSS Support” reference section and links to it from Story / Page documentation.
- Updates feature/support matrices and icons to include Markdown (
MD) as a supported input type.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/the-basics.rst | Replaces a conversion recommendation with a link to the central converting guide. |
| docs/supported-files-table.rst | Adds an MD icon entry and corresponding CSS for the supported file types table. |
| docs/recipes-stories.rst | Replaces inline CSS limitations with a link to the CSS support reference. |
| docs/page.rst | Links insert_htmlbox CSS parameter docs to the CSS support reference. |
| docs/images/icons/icon-md.svg | Adds the Markdown icon asset used by matrices/tables. |
| docs/how-to-open-a-file.rst | Adds empty-document open example and an “open() options” section. |
| docs/document.rst | Documents archive in the constructor signature and introduces Document.apply_css(). |
| docs/converting-files.rst | Expands conversion docs with a Markdown → PDF section (paper size, CSS, fonts) and reorders SVG section. |
| docs/archive-class.rst | Updates Archive description to include usage when opening files. |
| docs/app3.rst | Adds a new “CSS Support” appendix section listing supported/unsupported CSS features. |
| docs/about.rst | Updates product comparison to include MD as an input document type. |
| docs/about-feature-matrix.rst | Adds the MD icon embedding/CSS and shows MD in the feature matrix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1738ff5 to
42ec4af
Compare
JorjMcKie
approved these changes
Jun 3, 2026
42ec4af to
1c4cd33
Compare
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.
No description provided.