[Documentation] `docs/` W/ `sphinx` Finalization, PyCharm Refactoring

[Rubix982]

[Documentation] docs/ W/ sphinx Finalization, PyCharm Refactoring

Pull Request Type

• 📜 Documentation This pull request,
  • Fixes many RST modifications needed to render the documentation properly
  • Introduced RST changes to better organize the markdown files
  • Performed many variables and class static type-checking along with PyCharm refactoring suggestions
  • Introduces No breaking changes
  • Introduces method to generate documentation

This PR should close #117.

Purpose

• To preprocess many changes needed in the DocStrings to better format and organize the developer documentation that will be used by Docusaurus

To Review

• @OmarMuhammedAli No breaking changes, just heavy DocString fixes because of the RST syntax. See references.
• @cbeddow A bit heavy changes in the PR because of the lack of time, but it has no breaking changes, so that's pretty cool!

References

• Sphinx RST tutorial
• RST to MD for Python DocStrings, see the answer by Matteo Ferla, SO

Generated Files

@cbeddow these are the current MD files generated from the PR changes. I think the changes made the MD output look cleaner and more organized. You can see what they look like by downloading them, opening them with a text editor, copying the content, and pasting them into a markdown cell on Jupyter Notebook.

I think some MD files are too long, and I think I should be easy to solve with a Python script that splits the given MD file into smaller parts detecting were to break.

I have a small thing in mind from the Stack Overflow post, I'll share any modifications it performs on the MD outputs.

PFA::

mapillary.md mapillary.models.api.md mapillary.models.md mapillary.utils.md index.md mapillary.controller.md mapillary.config.md mapillary.config.api.md

[Rubix982]

I've added a Sphinx plugin (type hints) that also registers the type of the parameter being passed in the latest commit "Added Sphinx(+plugins) for doc generation … 642b200".