tudat-team / tudatpy

A Python platform to perform astrodynamics and space research.
https://tudat-space.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
29 stars 29 forks source link

[PoC] API docs refactoring: Include the docstring in the binding code itself replacing the call to the function `get_docstring()`. #149

Closed niketagrawal closed 2 months ago

niketagrawal commented 4 months ago

Steps

  1. Add cpp source in tudat repository, for example, a function to add two numbers.
  2. Add the binding code in tudatpy/. Include docstring in the binding code. Skip using generate_docstring(). For example, in this repository https://github.com/pybind/scikit_build_example
  3. Build the python extension module for the newly added function and test whether the python module can be imported successfully in the Python interpreter.
  4. Build docs and test html files locally.

Since the above proof of concept involves code changes to both tudat and tudatpy, tudat-bundle seems to be the repository to experiment it, however, implementing the above proof of concept in tudat-bundle repository poses the following challenge:

Issues with this approach

niketagrawal commented 2 months ago

PoC completed. This idea will not be further explored. The approach described in #150 is a better alternative.