Skip to content

Fix Documentation not building#1332

Merged
hotzenklotz merged 1 commit into
masterfrom
fix-docs
Jul 8, 2025
Merged

Fix Documentation not building#1332
hotzenklotz merged 1 commit into
masterfrom
fix-docs

Conversation

@hotzenklotz

Copy link
Copy Markdown
Member

Description:

  • This PR fixes the failing docs builds. The mkdocs-video plugin is repsonsible for embedding YouTube videos and videos from S3/local in documents with an easy Markdown syntax.

Unfortunately, the mkdocs-video repository is not makred as archieved. We had been using a fork that include a crictical fix for document parsing in modern Python versions (3.10+?). That fork was delete causing our docs builds to break.

I forked the original mkdocs-video repo and apply said fixes. https://github.com/scalableminds/mkdocs-video

Todos:

Make sure to delete unnecessary points or to check all before merging:

  • Updated Changelog
  • Updated Documentation
  • Added / Updated Tests
  • Considered adding this to the Examples

@hotzenklotz hotzenklotz self-assigned this Jul 8, 2025
@hotzenklotz hotzenklotz requested a review from daniel-wer July 8, 2025 09:03

@daniel-wer daniel-wer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM. I'm not familiar with the docs build in the libs. Where can I see it failing and can we test whether it succeeds again now?

@hotzenklotz

Copy link
Copy Markdown
Member Author

In the CI / GitHub actions, we can not test it. Docs builds run only on master 🤔

I tested it locally:

cd docs
uv sync
./generate.sh

That should be the docs and spawn a live server with the docs. You can then view the docs in your browser.

@hotzenklotz hotzenklotz enabled auto-merge (squash) July 8, 2025 09:26
@hotzenklotz hotzenklotz disabled auto-merge July 8, 2025 09:28
@hotzenklotz hotzenklotz merged commit 53d32d8 into master Jul 8, 2025
23 of 25 checks passed
@hotzenklotz hotzenklotz deleted the fix-docs branch July 8, 2025 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants