{"package":"demopkg","base":"api/demopkg","generated":"2026-08-14T21:16:05.733Z","symbols":[{"path":"demopkg","kind":"module","page":"api/demopkg","anchor":"","brief":"Demo package used by the starlight-pydocs test suite."},{"path":"demopkg.DEFAULT_TIMEOUT","kind":"attribute","page":"api/demopkg","anchor":"demopkg.DEFAULT_TIMEOUT","brief":"Seconds to wait for report generation before giving up."},{"path":"demopkg.Report","kind":"class","page":"api/demopkg","anchor":"demopkg.Report","brief":"A named collection of scored sections."},{"path":"demopkg.Report.from_mapping","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.from_mapping","brief":"Build a report from an existing mapping of scores."},{"path":"demopkg.Report.generate","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.generate","brief":"Render the report and return the path it was written to."},{"path":"demopkg.Report.name","kind":"attribute","page":"api/demopkg","anchor":"demopkg.Report.name","brief":"The report name."},{"path":"demopkg.Report.render","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.render","brief":"Render one section or a list of sections."},{"path":"demopkg.Report.scores","kind":"attribute","page":"api/demopkg","anchor":"demopkg.Report.scores","brief":"Mapping of metric name to score."},{"path":"demopkg.Report.supported_formats","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.supported_formats","brief":"List the formats a report can be saved as."},{"path":"demopkg.Report.title","kind":"attribute","page":"api/demopkg","anchor":"demopkg.Report.title","brief":"Title used in the rendered output."},{"path":"demopkg.Report.format","kind":"attribute","page":"api/demopkg","anchor":"demopkg.Report.format","brief":"Default output format, as a bare file extension."},{"path":"demopkg.Report.is_valid","kind":"attribute","page":"api/demopkg","anchor":"demopkg.Report.is_valid","brief":"Whether validate passes."},{"path":"demopkg.Report.save","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.save","brief":"Write the rendered report to path."},{"path":"demopkg.Report.validate","kind":"function","page":"api/demopkg","anchor":"demopkg.Report.validate","brief":"Check the report for structural problems."},{"path":"demopkg.compat","kind":"module","page":"api/demopkg/compat","anchor":"","brief":"Backwards compatible aliases, without an __all__."},{"path":"demopkg.compat.LEGACY_LIMIT","kind":"attribute","page":"api/demopkg/compat","anchor":"demopkg.compat.LEGACY_LIMIT","brief":"Largest report size the old API accepted."},{"path":"demopkg.compat.legacy_name","kind":"function","page":"api/demopkg/compat","anchor":"demopkg.compat.legacy_name","brief":"Return the name the old API would have used."},{"path":"demopkg.generate_report","kind":"function","page":"api/demopkg","anchor":"demopkg.generate_report","brief":"Build a report from a source object."},{"path":"demopkg.models","kind":"module","page":"api/demopkg/models","anchor":"","brief":"Pydantic models, documented through the griffe_pydantic extension."},{"path":"demopkg.models.User","kind":"class","page":"api/demopkg/models","anchor":"demopkg.models.User","brief":"Someone who can own a report."},{"path":"demopkg.models.User.email","kind":"attribute","page":"api/demopkg/models","anchor":"demopkg.models.User.email","brief":"Contact address, lowercased on validation."},{"path":"demopkg.models.User.name","kind":"attribute","page":"api/demopkg/models","anchor":"demopkg.models.User.name","brief":"Display name of the user."},{"path":"demopkg.models.User.reports","kind":"attribute","page":"api/demopkg/models","anchor":"demopkg.models.User.reports","brief":"How many reports the user owns."},{"path":"demopkg.report","kind":"module","page":"api/demopkg/report","anchor":"","brief":"Report classes and the functions that build them."},{"path":"demopkg.report.BaseReport","kind":"class","page":"api/demopkg/report","anchor":"demopkg.report.BaseReport","brief":"Common behaviour shared by every report."},{"path":"demopkg.report.BaseReport.format","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.BaseReport.format","brief":"Default output format, as a bare file extension."},{"path":"demopkg.report.BaseReport.is_valid","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.BaseReport.is_valid","brief":"Whether validate passes."},{"path":"demopkg.report.BaseReport.save","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.BaseReport.save","brief":"Write the rendered report to path."},{"path":"demopkg.report.BaseReport.validate","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.BaseReport.validate","brief":"Check the report for structural problems."},{"path":"demopkg.report.Report","kind":"class","page":"api/demopkg/report","anchor":"demopkg.report.Report","brief":"A named collection of scored sections."},{"path":"demopkg.report.Report.from_mapping","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.from_mapping","brief":"Build a report from an existing mapping of scores."},{"path":"demopkg.report.Report.generate","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.generate","brief":"Render the report and return the path it was written to."},{"path":"demopkg.report.Report.name","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.Report.name","brief":"The report name."},{"path":"demopkg.report.Report.render","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.render","brief":"Render one section or a list of sections."},{"path":"demopkg.report.Report.scores","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.Report.scores","brief":"Mapping of metric name to score."},{"path":"demopkg.report.Report.supported_formats","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.supported_formats","brief":"List the formats a report can be saved as."},{"path":"demopkg.report.Report.title","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.Report.title","brief":"Title used in the rendered output."},{"path":"demopkg.report.Report.format","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.Report.format","brief":"Default output format, as a bare file extension."},{"path":"demopkg.report.Report.is_valid","kind":"attribute","page":"api/demopkg/report","anchor":"demopkg.report.Report.is_valid","brief":"Whether validate passes."},{"path":"demopkg.report.Report.save","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.save","brief":"Write the rendered report to path."},{"path":"demopkg.report.Report.validate","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.Report.validate","brief":"Check the report for structural problems."},{"path":"demopkg.report.ReportError","kind":"class","page":"api/demopkg/report","anchor":"demopkg.report.ReportError","brief":"Raised when a report cannot be generated."},{"path":"demopkg.report.ReportWarning","kind":"class","page":"api/demopkg/report","anchor":"demopkg.report.ReportWarning","brief":"Warned when a report is generated with incomplete data."},{"path":"demopkg.report.generate_report","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.generate_report","brief":"Build a report from a source object."},{"path":"demopkg.report.old_generate","kind":"function","page":"api/demopkg/report","anchor":"demopkg.report.old_generate","brief":"Build a report the old way."},{"path":"demopkg.utils","kind":"module","page":"api/demopkg/utils","anchor":"","brief":"Helpers that operate on reports."},{"path":"demopkg.utils.SECTION_STYLES","kind":"attribute","page":"api/demopkg/utils","anchor":"demopkg.utils.SECTION_STYLES","brief":"How each section of a rendered report is presented."},{"path":"demopkg.utils.describe","kind":"function","page":"api/demopkg/utils","anchor":"demopkg.utils.describe","brief":"Summarise a report in one line."},{"path":"demopkg.utils.iter_sections","kind":"function","page":"api/demopkg/utils","anchor":"demopkg.utils.iter_sections","brief":"Walk the sections of a report in render order."},{"path":"demopkg.utils.merge_scores","kind":"function","page":"api/demopkg/utils","anchor":"demopkg.utils.merge_scores","brief":"Combine the scores of two reports."}]}