Documentation Software - Zlatkoo25/CSE327-project GitHub Wiki
We are using SPHINX
First we have to install the autoDocstring - Python Docstrig Generator extension in Visual Studio code editor.
A settings.json file will be created where the properties of the documentation formats will be written and it can be edited according to requirements.
This is the code in the settings.json file:
{ "autoDocstring.docstringFormat": "numpy", "autoDocstring.includeExtendedSummary": true, "autoDocstring.includeName": true, "autoDocstring.logLevel": "Debug", "autoDocstring.startOnNewLine": true, "workbench.colorTheme": "GitHub Dark Default" }
Then we have to put 3 pairs of double quotation marks to add the documentation format.
Here is an example, it shows the documentation format for a simple addition function:
def add(number1, number2): """ add adds 2 numbers
extended_summary
Parameters ---------- number1 : int First Number number2 : int Second Number
Returns ------- int Sum """ return number1 + number2