Skip to content
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

Merged
merged 4 commits into from Dec 15, 2021

Conversation

danielhuppmann
Copy link
Member

This PR adds the intersphinx mapping to pyam and restructures the docs (rst pages and code docstrings) to use intersphinx markup.

@danielhuppmann danielhuppmann self-assigned this Dec 15, 2021
@danielhuppmann danielhuppmann added the documentation Improvements or additions to documentation label Dec 15, 2021
Copy link
Contributor

@phackstock phackstock left a 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?

Copy link
Contributor

@LauWien LauWien left a 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.

doc/source/getting_started.rst Show resolved Hide resolved
doc/source/getting_started.rst Outdated Show resolved Hide resolved
nomenclature/core.py Outdated Show resolved Hide resolved
nomenclature/core.py Show resolved Hide resolved
@phackstock phackstock mentioned this pull request Dec 15, 2021
@danielhuppmann
Copy link
Member Author

Response to @phackstock:

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?

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:nomenclature.RegionProcessor just works. So we should restructure the API documentation (ideally as a separate later PR - it's not a big problem if the link is not created right now).

@phackstock
Copy link
Contributor

@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>
@danielhuppmann danielhuppmann merged commit ef3a1ec into IAMconsortium:main Dec 15, 2021
@danielhuppmann danielhuppmann mentioned this pull request Dec 15, 2021
@danielhuppmann danielhuppmann deleted the docs/intersphinx branch January 19, 2022 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants