Skip to content

fix RoomConfig attributes display in docs #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
p1003 merged 2 commits into from
Dec 5, 2025
Merged

fix RoomConfig attributes display in docs #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9912628
fix RoomConfig attributes display in docs
p1003 Dec 5, 2025
5d3aa26
update main docs as well
p1003 Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ instance/
/doc
/docusaurus

*.DS_Store

# PyBuilder
.pybuilder/
target/
Expand Down
6 changes: 5 additions & 1 deletion templates/doc/module.html.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,11 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
{% enddefaultmacro %}
{% defaultmacro docstring(var) %}
{% if var.docstring %}
<div class="docstring">{{ var.docstring | to_markdown | to_html | linkify(namespace=var.qualname) }}</div>
{% set processed_docstring = var.docstring
| replace('\n ', '\n ')
| replace('\n ', '\n- ')
%}
<div class="docstring">{{ processed_docstring | to_markdown | to_html | linkify(namespace=var.qualname) }}</div>
{% endif %}
{% enddefaultmacro %}
{% defaultmacro nav_members(members) %}
Expand Down
12 changes: 10 additions & 2 deletions templates/docusaurus/module.html.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

{% block module_info %}
{% if module.docstring and ".. include::" not in module.docstring %}
{{ module.docstring | safe }}
{{ module.docstring
| replace('\n ', '\n ')
| replace('\n ', '\n- ')
| safe
}}
{% endif %}
{% endblock %}

Expand Down Expand Up @@ -89,7 +93,11 @@ class {{ cls.qualname }}{{ class_bases(cls) }}:
```python
{% if doc.kind == "class" %}{{ class(doc) }}{% elif doc.kind == "function" %}{{ function(doc) }}{% else %}{{ variable(doc) }}{% endif %}
```
{{ doc.docstring | safe }}
{{ doc.docstring
| replace('\n ', '\n ')
| replace('\n ', '\n- ')
| safe
}}
{% enddefaultmacro %}

{% defaultmacro is_public(doc) %}
Expand Down