Rubix982
commented
3 years ago I've been looking into "Read The Docs". I was able to successfully create an account, but after that, I tried finding the mapillary-python-sdk repository to no avail. I tried giving "Read The Docs" the link to the repository, but the build fails. There is a webhook integration I can try, but before that, I read the following excerpts from the documentation,
"Read the Docs is Open Source software. We have licensed the code base as MIT, which provides almost no restrictions on the use of the code" - Read the Docs Open Source Philosophy
And,
"For private repositories, please use Read the Docs for Business" - Importing Your Documentation
I'll keep trying with the options I have and spend a bit more time on this, but maybe the primary issue is due to the private repository issue.
@cbeddow, should I send a PR with the base "Read The Docs" code for the docs/ folder?
We need a folder in the main/root directory called "docs".
Sign up for an account at: https://readthedocs.org/
We should then use the following instructions to generate documentation with Mkdocs: https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html
We need to somehow create the docs then attempt to import to read the docs.
The generated documentation will go in the docs folder.
It should look similar to the setup in OSMnx library here: https://github.com/gboeing/osmnx
And we can model after the OSMnx library docs: https://osmnx.readthedocs.io/en/stable/