Skip to content

Commit

Permalink
Added pydoctor to CONTRIBUTING.md (#201)
Browse files Browse the repository at this point in the history
  • Loading branch information
kozlov721 authored Nov 6, 2024
1 parent 32238bd commit 9c5d12a
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,11 @@ We use pre-commit hooks to ensure code quality and consistency:
## Documentation

We use the [Epytext](https://epydoc.sourceforge.net/epytext.html) markup language for documentation.
To verify that your documentation is formatted correctly, follow these steps:
To verify that your documentation is formatted correctly, run the following command:

1. Download [`get-docs.py`](https://github.com/luxonis/python-api-analyzer-to-json/blob/main/gen-docs.py) script
1. Run `python3 get-docs.py luxonis_ml` in the root directory.
- If the script runs successfully and produces `docs.json` file, your documentation is formatted correctly.

> \[!NOTE\]
> If the script fails, it might not give a specific error message.
> In that case, you can run the script for each file individually
> until you find the one that is causing the error.
```bash
pydoctor --docformat=epytext luxonis_ml
```

### Editor Support

Expand Down

0 comments on commit 9c5d12a

Please sign in to comment.