mapillary / mapillary-python-sdk

A Python 3 library built on the Mapillary API v4 to facilitate retrieving and working with Mapillary data.
MIT License
37 stars 14 forks source link

[Documentation] Markdown results not rendered properly #117

Closed Rubix982 closed 2 years ago

Rubix982 commented 2 years ago

Describe the bug The output of the DocStrings turned into MD is not organized, messy, and not properly formatted as expected. This may be due to RST formatting issues

To Reproduce Run the following commands in the root of the project

❯ sphinx-apidoc -o docs ./src/ sphinx-apidoc --full -A 'Saif Ul Islam'; cd docs; make markdown;

Expected behavior Clear, concise, and as expected documentation changes to appear.

Screenshots N/A

Additional context N/A