Skip to content

Conversation

@p1003
Copy link
Contributor

@p1003 p1003 commented Dec 3, 2025

Description

We would like to include python-server-sdk docs 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

  • Documentation update required
  • Documentation updated in another PR
  • No documentation update required

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)

@linear
Copy link

linear bot commented Dec 3, 2025

@p1003 p1003 self-assigned this Dec 3, 2025
@p1003 p1003 marked this pull request as ready for review December 3, 2025 16:24
@p1003 p1003 requested a review from Copilot December 3, 2025 16:25
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_docusaurus script 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.

@p1003 p1003 force-pushed the FCE-2160 branch 3 times, most recently from 87e79dc to dfa5a1a Compare December 4, 2025 09:31
Copy link
Member

@PiotrWodecki PiotrWodecki left a comment

Choose a reason for hiding this comment

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

Some content renders really badly, but that was true for the previous versions as well. Let's improve from here

@p1003
Copy link
Contributor Author

p1003 commented Dec 4, 2025

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.

@p1003 p1003 merged commit 04bbea6 into main Dec 4, 2025
6 checks passed
@p1003 p1003 deleted the FCE-2160 branch December 4, 2025 12:39
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.

3 participants