Docs inline code formatting

[wsdewitt]

Some minor docs fixes are needed to format inline code: rst uses double backticks, not single backticks like markdown, for inline code. As is, inline code is being italicized. For example:

multidms/CONTRIBUTING.rst

Line 43 in 79dc61a

In any case, please run Black using `black .` before submitting your PR, because the actions tests will not pass unless the files have been formatted.

[jgallowa07]

@wsdewitt Had some other docs formatting ideas on slack. This seems like a reasonable place to save them for later:

wsdewitt
18 minutes ago
So I wrote the jaxmodels module using google style (rather than numpy style) docstrings, which seems to interact better with type hints and the jaxtyping module. Are we ok with that for this module? The rendered docs look ok, so sphinx has no problems. However, I noticed that the API docs are very hard to find in the docs page. This might be because the doc content of multidms/init.py overloads the docs/multidms.rst file? The docs need some reorganization to surface the API docs.

jgallowa07
9 minutes ago
Are we ok with that for this module?
I'm fine with that.
However, I noticed that the API docs are very hard to find in the docs page. This might be because ...
I agree it might be nice to have more clear access to the module index . We could simply replace "multidms package" and/or add this the index? (edited)