from nicegui import ui from ..header import add_head_html, add_header from ..style import section_heading, subheading from .content import DocumentationPage from .demo import demo from .reference import generate_class_doc def render_page(documentation: DocumentationPage, *, with_menu: bool = True) -> None: """Render the documentation.""" # menu if with_menu: with ui.left_drawer() \ .classes('column no-wrap gap-1 bg-[#eee] dark:bg-[#1b1b1b] mt-[-20px] px-8 py-20') \ .style('height: calc(100% + 20px) !important') as menu: if documentation.back_link: ui.markdown(f'[← back]({documentation.back_link or "."})').classes('bold-links') else: ui.markdown('[← Overview](/documentation)').classes('bold-links') ui.markdown(f'**{documentation.heading.replace("*", "")}**').classes('mt-4') else: menu = None # header add_head_html() add_header(menu) ui.add_css('html {scroll-behavior: auto}') title = (documentation.title or '').replace('*', '') ui.page_title('NiceGUI' if not title else title if title.split()[0] == 'NiceGUI' else f'{title} | NiceGUI') # content def render_content(): section_heading(documentation.subtitle or '', documentation.heading) for part in documentation.parts: if part.title: if part.link_target: ui.link_target(part.link_target) subheading(part.title, link=part.link, major=part.reference is not None) if part.description: if part.description_format == 'rst': element = ui.restructured_text(part.description.replace(':param ', ':')) else: element = ui.markdown(part.description) element.classes('bold-links arrow-links') if ':param' in part.description: element.classes('rst-param-tables') if part.ui: part.ui() if part.demo: demo(part.demo.function, lazy=part.demo.lazy, tab=part.demo.tab) if part.reference: generate_class_doc(part.reference, part.title) if part.link: ui.markdown(f'See [more...]({part.link})').classes('bold-links arrow-links') with ui.column().classes('w-full p-8 lg:p-16 max-w-[1250px] mx-auto'): if documentation.extra_column: with ui.grid().classes('grid-cols-[2fr_1fr] max-[600px]:grid-cols-[1fr] gap-x-8 gap-y-16'): with ui.column().classes('w-full'): render_content() with ui.column(): documentation.extra_column() else: render_content()