Error rendering docstrings

[yiquintero]

Description

The docstrings for the functions listed below are incorrectly rendered by Sphinx. The issue occurs when building the documentation locally using tudat-multidoc (tudat CLI) or the new method introduced as part of the 2024 updates to the tudatpy API documentation workflow. The docstrings are also rendered incorrectly on the API Reference website.

The error is the same in all cases: a reference to binary object address is included in the signature of the function, which is auto-generated by Sphinx. See the image below for an example.

Steps to reproduce

1. Build tudatpy: Clone the tudat-bundle repo. Checkout the develop branch of tudat & tudatpy. Build tudatpy following the instructions in the readme file of tudat-bundle.
2. Build the documentation: With the tudat-bundle conda env used in 1 still activated, build the docs locally by going to tudat-bundle/tudatpy/docs/ and running the command make html
3. Explore the docs: Open the file tudatpy/docs/build/html/index.html with a web browser and search for one of the functions listed below.

Problematic Functions

Ephemeris

List of Functions

1. interpolated_spice
2. tabulated_from_existing

Estimation

List of Functions

1. add_dependent_variable
2. compatible_dependent_variable_settings
3. compatible_dependent_variables_list
4. concatenated_dependent_variable
5. dependent_variable
6. dependent_variable_history
7. dependent_variable_history_per_set
8. filter_observations
9. get_bodies_in_link_ends
10. get_computed_observations
11. get_concatenated_computed_observations
12. get_concatenated_float_observation_times
13. get_concatenated_observation_times
14. get_concatenated_observations
15. get_concatenated_observations_and_times
16. get_concatenated_residuals
17. get_concatenated_weights
18. get_mean_residuals
19. get_observable_types
20. get_observation_times
21. get_observations
22. get_observations_and_times
23. get_reference_points_in_link_ends
24. get_residuals
25. get_rms_residuals
26. get_single_observation_sets
27. get_time_bounds_list
28. get_time_bounds_per_set
29. get_weights
30. set_constant_weight (x2)
31. set_reference_point (x2)
32. set_reference_points
33. set_tabulated_weights
34. split_observation_sets
35. EstimationInput constructor

Observation

List of Functions

1. two_way_doppler_averaged
2. one_way_range
3. n_way_range
4. two_way_range
5. angular position
6. relative_angular_position
7. one_way_doppler_instantaneous
8. one way doppler averaged
9. n_way_doppler_averaged
10. n_way_doppler_averaged_from_one_way_links

Propagator

List of Functions

1. hybrid_arc
2. translational
3. rotational
4. mass
5. multitype
6. multi_arc