Open niketagrawal opened 6 months ago
Implementation in WIP/extract-docs-from-python-modules
make html
and view the html in the browser. Above mentioned proof of concept was further modified to match the new requirements. Scroll to the bottom of this issue to read the latest updates.
Work on this issue will be resumed after #146
Python native modules which need to rendered together with the API docs
docs/environment_readthedocs.yaml
. use the command conda env create -f docs/environment_readthedocs.yaml
cd docs/
make html
docs/build/html
directory. Open the page index.html
in the browser. central_sbdb
from the python native module sbdb_wrapper.py
there. jpl_horizons
from the python native module horizons_wrapper.py
there.Changes work fine on read the docs. See the rendered docs for this proof of concept: https://py.api.tudat.space/en/144-render-python-native-docs/
Documentation (docstrings) from the pure Python modules in the tudatpy repository should appear on the API docs page alongside the API docs for the bindings.