Skip to content

Convert doc strings to format parseable by Sphinx to fix the dev docs #12971

@LeonarddeR

Description

@LeonarddeR

In #9840, NVDA dev docs were restored for Python 3 by building them with SPhinx. However, the layout of these docs is quite bad as we aren't using the proper format in doc strings.

I created a gist that contains prototype code to convert doc strings to sphinx style using regex.

https://gist.github.com/leonardder/82564a57a1a79a36fad79c1b92771c29

This could be a starting point.

Originally posted by @LeonarddeR in #9840 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    audience/nvda-devPR or issue is relevant to NVDA / Add-on developersp5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions