New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add intersphinx mapping #77
Add intersphinx mapping #77
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice addition of referencing both within the package and to pyam as well.
Right now, the link for ":class:RegionProcessor
" is not working because in the api docs I included it as "automodule:: nomenclature.processor.region" and not "autoclass:: RegionProcessor". Should we fix it here or should I address it in #76?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great :)
Just a few suggestions inline.
Response to @phackstock:
I think a priority is to make intersphinx operate smoothly also for other users pointing to our docs, so we should make sure that :class: |
@danielhuppmann ok, sounds good. Then good to merge from my side. I'll rebase #76 once we've merged. |
Co-authored-by: Laura Wienpahl <57132039+LauWien@users.noreply.github.com>
This PR adds the intersphinx mapping to pyam and restructures the docs (rst pages and code docstrings) to use intersphinx markup.