Comments (9)
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.
Related Issues (20)
- drone.info.get_version() INFORMATION_NOT_RECEIVED_YET HOT 8
- FILE_DOES_NOT_EXIST on calling the drone.ftp.list_directory() to fetch internal directories file HOT 13
- The use of drone.offboard.set_position_ned HOT 9
- Unable to upload rally_items through MAVSDK HOT 10
- Error when uploading mission: INVALID_PARAM1 HOT 6
- `aiogrpc` RuntimeError HOT 35
- Running missions in ArduPilot HOT 12
- How to use mavsdk-python to takeoff without GPS HOT 4
- How do I use `telemetry_server` correctly? HOT 4
- Analyzing log files or Distance travelled data from mavsdk python HOT 5
- Geofence crashes with the only information being "Error" HOT 1
- connectivity HOT 5
- Support custom COMMAND_LONG listeners and be able to ACK HOT 6
- can't connect to QGC via UDP connection using mavsdk HOT 3
- Get HEARTBEAT message from MAVSDK HOT 5
- How to use Mavsdk to call Led_control to control LED lights? HOT 2
- MAVSDK server not connecting with JMAVSIM - Windows WSL HOT 2
- How can I set flight mode - manual mode? HOT 1
- Altitude error while doing swarming using mavsdk-python ? HOT 2
- RuntimeError: Task pending got Future attached to a different loop during Offboard control with FastAPI and MAVSDK HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mavsdk-python.