search

tudat-team / tudat-space

An introduction and guide to tudat-space.
https://tudat-space.readthedocs.io
15 stars 17 forks source link

Reorganization of integrator settings #39

Closed FilippoOggionni closed 2 years ago

FilippoOggionni commented 2 years ago

See #37.

DominicDirkx commented 2 years ago

Thanks, my bad for not opening this :)

FilippoOggionni commented 2 years ago

No worries, I am developing a (dangerous) sense of satisfaction in opening pull requests... Which makes me think I should stay away from my laptop for a while 😅

The structure looks good to me! I have pushed a couple of minor changes.

Also, given the nature of the content of this page (quite technical, although the page does not - rightfully - go into much detail), I would add a box at the bottom with a short list of references for users who want to read more about the topic (e.g., "Numerical recipes in C++", the tudat technical documentation, and/or similar). Now that I think about it, this could be something that could fit nicely on other selected pages as well...

DominicDirkx commented 2 years ago

Coming back to your remark on references, how about having a Bilbiography on tudat-space? Books like Numerical Recipes are bound to be referenced from various pages.

FilippoOggionni commented 2 years ago

That is a good idea! I am not sure what is the best way to achieve that with Sphinx. The simplest option would be to have a separate page with references and we can link the references from different locations, as we do with regular sphinx interlinking. Otherwise, there is an actual sphinx bibliography entry (see this link), but I think that would not have the advantage of a "centralized" list of reference, because with that command the bibliography item must go at the bottom of the page it is cited in.

DominicDirkx commented 2 years ago

Separate issue opened for the issue of bibliography