-
-
Notifications
You must be signed in to change notification settings - Fork 784
Convert doc strings to format parseable by Sphinx to fix the dev docs #12971
Copy link
Copy link
Open
Labels
audience/nvda-devPR or issue is relevant to NVDA / Add-on developersPR or issue is relevant to NVDA / Add-on developersp5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
Metadata
Metadata
Assignees
Labels
audience/nvda-devPR or issue is relevant to NVDA / Add-on developersPR or issue is relevant to NVDA / Add-on developersp5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
Type
Fields
Give feedbackNo fields configured for issues without a type.
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)