Move docs/examples to /examples about mavsdk-python HOT 9 CLOSED

I am a huge fan of Sphinx, but we have about 7 non-Python doc sets, hosted using gitbook on gitbook.com. It makes no sense for one of them to be documented using a different toolchain and markup.

So lets write in markdown. In the first instance we can just use the wiki for docs.

It is possible to convert between reStructuredText and markdown using tools like pandoc, but it is a pain to do and keep doing. So lets not.

from mavsdk-python.

I planned on using Sphinx for the Code Documentation - can you convert that to gitbook?

from mavsdk-python.

Okay!
I'd like to have some in-code documentation. Makes it easier to work witth! Do you have any proposal for python that is compatible with gitbook?

from mavsdk-python.

I'd like to have some in-code documentation. Makes it easier to work witth! Do you have any proposal for python that is compatible with gitbook?

I completely understand. Unfortunately we're too early down the client API and docs path for me to give final advice.

For now, just document it however you prefer, ignoring the ultimate toolchain. Note however that it might all get ripped out and modified at some point in future. I'm not saying that will happen - it is possible that the model for docs will end up being "every client library for itself".

from mavsdk-python.

And in either case, please move examples folder into the root :-)

from mavsdk-python.

Okay - I will just document the functions and the general behaviour - we might not even have to document every function in the official documentation (e.g. internal use only functions)

And in either case, please move examples folder into the root :-)

Sure, will be done on my next PR!

from mavsdk-python.

Thank you. I personally am only interested in the public API. Feel free to use your wiki for documentation too - we can pull anything that gets created into the final docset!

from mavsdk-python.

I think this can be closed now!

from mavsdk-python.

Yes it can. Thank you!

from mavsdk-python.