Skip to content

Fix PDF artifacts and align documentation metadata#1077

Merged
SkBlaz merged 4 commits into
masterfrom
copilot/polish-docs-and-verify-alignment
Jan 13, 2026
Merged

Fix PDF artifacts and align documentation metadata#1077
SkBlaz merged 4 commits into
masterfrom
copilot/polish-docs-and-verify-alignment

Conversation

Copilot AI commented Jan 13, 2026

Copy link
Copy Markdown
Contributor

The generated documentation PDF contained rendering artifacts (code continuation markers ˓→ on 221 pages, visible space markers on 122 pages) and version numbers were inconsistent with pyproject.toml.

Changes

  • LaTeX configuration (docfiles/conf.py): Added verbatimwrapslines=false, verbatimvisiblespace=false, and Unicode handling to eliminate PDF artifacts. Aligns with working book/conf.py settings.

  • Version alignment: Updated docfiles/conf.py and book/conf.py from 1.1.0 → 1.1.1 to match pyproject.toml.

  • Example path correction (docfiles/config_workflows.rst): Fixed non-existent examples/config_driven/examples/workflows/.

The book PDF already passed verification; these fixes target the main documentation PDF. Docker-compose references in docs are intentional legacy command explanations.

Original prompt

This section details on the original issue you should resolve

<issue_title>docs polishing pass</issue_title>
<issue_description>go over rst docs and pdf book, verify alignment with repo and clarity.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 13, 2026 17:41
Updated docfiles/conf.py to prevent code wrap continuation markers
and visible space markers in generated PDFs by:
- Setting verbatimwrapslines=false to disable line wrapping
- Setting verbatimvisiblespace=false to hide space markers
- Setting verbatimhintsturnover=false to remove page continuation markers
- Adding fancyvrb and Unicode handling in LaTeX preamble

This aligns the docfiles config with the working book config.

Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Synchronized version numbers in documentation configs with pyproject.toml:
- docfiles/conf.py: 1.1.0 → 1.1.1
- book/conf.py: 1.1.0 → 1.1.1

This ensures consistency across all project metadata.

Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Corrected path from examples/config_driven/ to examples/workflows/
in docfiles/config_workflows.rst to match actual repository structure.

Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Copilot AI changed the title [WIP] Polish and verify alignment of documentation Fix PDF artifacts and align documentation metadata Jan 13, 2026
Copilot AI requested a review from SkBlaz January 13, 2026 17:46
@SkBlaz
SkBlaz marked this pull request as ready for review January 13, 2026 19:02
@SkBlaz
SkBlaz merged commit 1a2eaf3 into master Jan 13, 2026
32 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.

docs polishing pass

2 participants