Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds Docusaurus-compatible documentation generation for the python-server-sdk by introducing new Jinja2 templates and a generation script. The changes enable the project's documentation to be integrated into docs.fishjam.io.
Key changes:
- New Docusaurus-specific Jinja2 templates that output Markdown with frontmatter instead of HTML
- New
generate_docusaurusscript function that generates and processes documentation for Docusaurus compatibility - Content sanitization to escape MDX special characters and clean up fully-qualified type names
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| templates/docusaurus/module.html.jinja2 | New template for rendering module documentation as Markdown with Python syntax highlighting |
| templates/docusaurus/frame.html.jinja2 | New template providing Docusaurus frontmatter structure for documentation pages |
| scripts.py | Adds generate_docusaurus function with MDX content cleaning and reorganizes existing generate_docs function |
| pyproject.toml | Registers new generate_docusaurus command in project scripts |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
87e79dc to
dfa5a1a
Compare
PiotrWodecki
left a comment
There was a problem hiding this comment.
Some content renders really badly, but that was true for the previous versions as well. Let's improve from here
I can wait with merging the documentation PR and fix those first if we want. |
Description
We would like to include
python-server-sdkdocs in docs.fishjam.io but to do that they need to be compatible with docusaurus format.To see how the docs look I recommend checking out this documentation changes locally.
Documentation impact
Types of changes
not work as expected)