Conversation
new caption, API reference, for python modules further up add the citation logo link as place holder text
|
#658 has not been addressed yet because, afaik, it's the only place where we tell how we want to be cited. |
|
We can of course add the information how we wish to be cited to the documentation index. It would also be nice to add a separate documentation page that lists all publications on Climada. |
| .. toctree:: | ||
| :caption: API Reference | ||
| :hidden: | ||
|
|
||
| Python Modules <climada/climada> |
There was a problem hiding this comment.
Why not rename "Python Modules" to "API Reference", and leave it in the original toctree? I would not add this as a separate toctree with caption because I don't see that we add any other entries in the future. And a separate caption for only a single item does not make much sense to me
There was a problem hiding this comment.
- It definitely deserves its own section. (I agree that a single item is a wee bit awkward. I wanted to make the section title [API Reference] interactive and unfold subsections only when I actually click on it, but I couldn't figure out how to do that.)
- For making navigation easier. When I browse through the API reference and its navigation is at the bottom of the page I lose context through re-rendering whenever I click on a module. When it's on top, the unfolded doc-tree is stable.
👍 True. But not yet in 3.3, I'd say. 😁 |
|
@peanutfun: Do you mind if I merge now? |
2 participants
General improvement of the docs
Changes proposed in this PR:
This PR circumvents #658
PR Author Checklist
develop)PR Reviewer Checklist