The auto-generated API reference is full of open questions about dronekit-python HOT 4 CLOSED

There are easy ways to do this:

1. Use .. only:: draft
   This will add the the stuff in the block only in a "draft" build - omitting it from the final build.
2. Use the todo extension. I like this because you can mark up any text as a TODO and view it in a todo build (only). In that same build you can use another construct to list all the TODO items.

from dronekit-python.

I agree, lets remove them from Sphinx!

from dronekit-python.

@mrpollo What release are we up to for the API? Also, how can I work this out for myself?

Specifically in droneapi.lib.Mission and get_mission it has "PLACEHOLDER - will not be included in the release 1 python API, they will only be accessible from the REST API. (This is based on the most likely use-cases wanting a REST interface)"

I can see this isn't supported, so just interested in how I find out the latest tag/version.

from dronekit-python.

I have submitted fix to this in #58:

• All the FIXME comments are still present, but as they appear in a todo directive they are not automatically displayed when you build the documentation.

• The todos are rendered if you build with the correct flag:
  make -e SPHINXOPTS="-D todo_include_todos=1" html

  (or using our vagrant tool you can do:
  vagrant ssh -c "cd /vagrant/docs && make -e SPHINXOPTS='-D todo_include_todos=1' html"

  There is an example in this temporary dropbox link. The todos are visible in the text, and are listed at the end. Note that the rendering isn't good - I will raise in a separate defect.

In addition to these changes I made a number of other fixes to the documentation, including linking API reference items, and fixing some errors in names. I have not yet sanity checked the whole API.

I am closing this, as it will be addressed when #58 is merged.

from dronekit-python.