# {py:mod}`drafty_dev.docs.docstrings` ```{py:module} drafty_dev.docs.docstrings ``` ```{autodoc2-docstring} drafty_dev.docs.docstrings :parser: drafty_dev.docs.docstrings :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`MystNumpyDocHybridParser ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.MystNumpyDocHybridParser :parser: drafty_dev.docs.docstrings :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`render_see_also ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_see_also :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`render_see_also_section ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_see_also_section :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`render_regular_section ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_regular_section :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`render_parameter ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_parameter :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`render_parameter_section ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_parameter_section :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`report_errors_in_docstring ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.report_errors_in_docstring :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`to_pure_markdown ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.to_pure_markdown :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`replace_output_files_title ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.replace_output_files_title :parser: drafty_dev.docs.docstrings :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`_PARAMETERS_SECTIONS ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings._PARAMETERS_SECTIONS :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`_REGULAR_SECTIONS ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings._REGULAR_SECTIONS :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`_OTHER_PARAMETERS ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings._OTHER_PARAMETERS :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`_OUTPUT_SECTION_TITLE ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings._OUTPUT_SECTION_TITLE :parser: drafty_dev.docs.docstrings :summary: ``` * - {py:obj}`Parser ` - ```{autodoc2-docstring} drafty_dev.docs.docstrings.Parser :parser: drafty_dev.docs.docstrings :summary: ``` ```` ### API ````{py:data} _PARAMETERS_SECTIONS :canonical: drafty_dev.docs.docstrings._PARAMETERS_SECTIONS :type: typing.Final[tuple[str, ...]] :value: > ('Parameters', 'Returns', 'Yields', 'Receives', 'Other Parameters', 'Raises', 'Warns', 'Attributes') ```{autodoc2-docstring} drafty_dev.docs.docstrings._PARAMETERS_SECTIONS :parser: drafty_dev.docs.docstrings ``` ```` ````{py:data} _REGULAR_SECTIONS :canonical: drafty_dev.docs.docstrings._REGULAR_SECTIONS :type: typing.Final[tuple[str, ...]] :value: > ('Warnings', 'Notes', 'References', 'Examples') ```{autodoc2-docstring} drafty_dev.docs.docstrings._REGULAR_SECTIONS :parser: drafty_dev.docs.docstrings ``` ```` ````{py:data} _OTHER_PARAMETERS :canonical: drafty_dev.docs.docstrings._OTHER_PARAMETERS :value: > 'compile(...)' ```{autodoc2-docstring} drafty_dev.docs.docstrings._OTHER_PARAMETERS :parser: drafty_dev.docs.docstrings ``` ```` ````{py:data} _OUTPUT_SECTION_TITLE :canonical: drafty_dev.docs.docstrings._OUTPUT_SECTION_TITLE :value: > 'compile(...)' ```{autodoc2-docstring} drafty_dev.docs.docstrings._OUTPUT_SECTION_TITLE :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} render_see_also(see_also: drafty_dev.docs.types.SingleSeeAlso) -> str :canonical: drafty_dev.docs.docstrings.render_see_also ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_see_also :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} render_see_also_section(section: drafty_dev.docs.types.SeeAlsoSection) -> str :canonical: drafty_dev.docs.docstrings.render_see_also_section ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_see_also_section :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} render_regular_section(section: drafty_dev.docs.types.RegularSection) -> str :canonical: drafty_dev.docs.docstrings.render_regular_section ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_regular_section :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} render_parameter(parameter: numpydoc.docscrape.Parameter) -> str :canonical: drafty_dev.docs.docstrings.render_parameter ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_parameter :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} render_parameter_section(section: list[numpydoc.docscrape.Parameter]) -> str :canonical: drafty_dev.docs.docstrings.render_parameter_section ```{autodoc2-docstring} drafty_dev.docs.docstrings.render_parameter_section :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} report_errors_in_docstring(doc: str, document: docutils.nodes.document) -> None :canonical: drafty_dev.docs.docstrings.report_errors_in_docstring ```{autodoc2-docstring} drafty_dev.docs.docstrings.report_errors_in_docstring :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} to_pure_markdown(doc: str, use_other_params_as_outputs: bool = True) -> str :canonical: drafty_dev.docs.docstrings.to_pure_markdown ```{autodoc2-docstring} drafty_dev.docs.docstrings.to_pure_markdown :parser: drafty_dev.docs.docstrings ``` ```` ````{py:function} replace_output_files_title(doc: str, source: str | None) -> str :canonical: drafty_dev.docs.docstrings.replace_output_files_title ```{autodoc2-docstring} drafty_dev.docs.docstrings.replace_output_files_title :parser: drafty_dev.docs.docstrings ``` ```` `````{py:class} MystNumpyDocHybridParser :canonical: drafty_dev.docs.docstrings.MystNumpyDocHybridParser Bases: {py:obj}`myst_parser.parsers.sphinx_.MystParser` ```{autodoc2-docstring} drafty_dev.docs.docstrings.MystNumpyDocHybridParser :parser: drafty_dev.docs.docstrings ``` ````{py:method} parse(inputstring: str, document: docutils.nodes.document) -> None :canonical: drafty_dev.docs.docstrings.MystNumpyDocHybridParser.parse ```{autodoc2-docstring} drafty_dev.docs.docstrings.MystNumpyDocHybridParser.parse :parser: drafty_dev.docs.docstrings ``` ```` ````` ````{py:data} Parser :canonical: drafty_dev.docs.docstrings.Parser :value: > None ```{autodoc2-docstring} drafty_dev.docs.docstrings.Parser :parser: drafty_dev.docs.docstrings ``` ````