Setup SWIG and Sphinx to generate docs for Python bindings #163
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Setup SWIG and Sphinx to generate docs for Python bindings
Our current docs pipeline for c++ is:
This adds a pipeline for Python bindings:
Another option would be to use Doxygen for Python bindings as well.
However Doxygen isn't intended for Python and it generates the binding
xmls improperly resulting in uglier html docs.
Still it is not a perfect solution, the docs string are meant for C++
and the notation can look out of place in Python docs.
We are limited by what Swig generates so functions with multiple
arguments have a signature of
function_name(*args)
(arguments aredescribed correctly in the documentation it self).
Swig handles overloads by wrapping them into one function so it is
again only described in the docs for the particular functions (ideally
each overload would have its own function).
Resulting example:
