Niket Agrawal

Sphinx documentation build fails on Windows 10 when using jupyter-sphinx extension

9

### Description Sphinx documentation fails to build on Windows 10 when jupyter-sphinx extension is used to embed python code in the documentation. ``` $ sphinx-build . _build Running Sphinx v3.3.1...

No directive entry for "jupyter-execute" in module "docutils.parsers.rst.languages.en".

1

### Description The below warning is highlighted by the linter when jupyter-sphinx extension is used to embed python code in the documentation generated using sphinx on a Windows 10 PC....

Include Python native docstrings on the API docs website

4

Documentation (docstrings) from the pure Python modules in the tudatpy repository should appear on the [API docs page](https://py.api.tudat.space/en/latest/) alongside the API docs for the bindings. - [x] Determine the code...

Add in-code documentation via docstrings

1

Consider using module-level, class-level and function-level docstrings for describing the purpose of the module, description of the class or a function (especially when the function name and arguments can't convey...

- [ ] Provide information on how to run the examples. Mention the pre-requisities, for example, if a licensed software is required. - [ ] Specify the installation pre-requisites before...

[PoC] API docs refactoring: Use one time generated docstrings.h as the primary source for adding and extracting the docstrings

1

### Proof of concept implementation steps Make the below changes in a feature branch in tudatpy repository. Then, use tudat-bundle to fetch these changes within the tudatpy git submodule and...

### Challenges and issues in current implementation - The process of creating new API documentation is cumbersome. It involves multiple repositories. It is desired to have this process simplified. -...

### 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....