Skip to content

attempt running mkdocs#63

Merged
chgray merged 33 commits intomainfrom
user/chgray/auto_publish_main_mkdocs
Aug 21, 2025
Merged

attempt running mkdocs#63
chgray merged 33 commits intomainfrom
user/chgray/auto_publish_main_mkdocs

Conversation

@chgray
Copy link
Contributor

@chgray chgray commented Aug 21, 2025

This pull request primarily removes dependencies on the CDocsMarkdownCommentRender filter and its related environment setup from the documentation build and conversion scripts. It also updates a documentation link for clarity.

This filter is only used for the {DOCX, PDF, ePUB} file generation.

I do think this filter is useful, but it's too fragile / complicated and upon reflection shouldn't be in the main branch.

I'd like to add it back in the future, but only when it's less fragile and complicated.

Below are the most important changes grouped by theme:
Removal of CDocsMarkdownCommentRender Filter and Environment Setup:

  • Eliminated all references to CDocsMarkdownCommentRender from the tools/PreCheckinUpdate.sh script, including environment variable setup, binary checks, and filter usage in the pandoc command. This simplifies the script and removes the need to clone or build the CDocs repository. [1] [2]
  • Removed the addition of CDocsMarkdownCommentRender to the PATH in the tools/buildAsBook/Dockerfile.pandoc Dockerfile, further decoupling the build process from the CDocs toolchain.
  • Updated the tools/buildAsBook/bind.py script to remove the --filter CDocsMarkdownCommentRender flag from the pandoc command, ensuring markdown conversion no longer relies on this external filter.

General Script and Documentation Maintenance:

  • Removed container image checks and pulls for Docker/podman images related to document conversion from tools/PreCheckinUpdate.sh, streamlining the script and reducing complexity for local and CI builds.
  • Updated a documentation link in docs/docs/Rude_Q_and_A.md to point to the correct Actions overview document, improving documentation accuracy.Fixes #
    Design discussion issue #

Changes

Please provide a brief description of the changes here.

Merge requirement checklist

  • [*] CONTRIBUTING guidelines followed.
  • [*] Unit tests added/updated (if applicable).

@chgray chgray marked this pull request as ready for review August 21, 2025 18:28
@chgray chgray enabled auto-merge (squash) August 21, 2025 18:28
@chgray chgray merged commit 8412de4 into main Aug 21, 2025
6 checks passed
@chgray chgray deleted the user/chgray/auto_publish_main_mkdocs branch August 21, 2025 18:43
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.

2 participants