Clarify linke turbidity in docs for clearsky.ineichen#2746
Clarify linke turbidity in docs for clearsky.ineichen#2746cwhanse merged 9 commits intopvlib:mainfrom
Conversation
Co-authored-by: Anton Driesse <anton.driesse@pvperformancelabs.com>
Co-authored-by: Anton Driesse <anton.driesse@pvperformancelabs.com>
|
|
||
| Examples | ||
| -------- | ||
| https://pvlib-python.readthedocs.io/en/stable/user_guide/modeling_topics/clearsky.html#examples |
There was a problem hiding this comment.
Could we use an internal reference here?
There was a problem hiding this comment.
In modeling_topics.rst, add something like
.. _clearsky-examples:
at line 258 before the subsection Examples title.
Then, in this section, cross-reference with
See :ref:`clearsky-examples`
or
See :ref:`Clearsky Modeling Topic examples <clearsky-examples>`
(text between <> is the reference, prior to it is text to show; if omitted, I think it would plainly output "clearsky-examples"
There was a problem hiding this comment.
For me, the link doesn't appear where intended. Browser issue maybe?
There was a problem hiding this comment.
Do you mean that the title appears hidden by top navbar and you have to scroll a little up?
Latest commit anchors the reference to the paragraph instead of to the header. I'm pretty sure you must have nailed it at commit ea45ac0; I seem unable to understand why that wouldn't work for you.
There was a problem hiding this comment.
Its more than a whole page off. If the PR view isn't where the view will appear after the PR is merged, then I'd say move ahead, merge, and then fix if needed.
There was a problem hiding this comment.
Hmm I wasn't able to reproduce that yesterday. I'm okay with a follow-up. LGTM.
Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com>
…into linke_docs
kandersolar
left a comment
kandersolar
left a comment
There was a problem hiding this comment.
The internal link works as expected in the PR build, on my browser.
4 participants
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.