-
Notifications
You must be signed in to change notification settings - Fork 233
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
fix processors class docs hyperlink (issue #593) #903
Conversation
docs/tutorial/processors.ipynb
Outdated
@@ -6,7 +6,7 @@ | |||
"source": [ | |||
"# Processors\n", | |||
"\n", | |||
"Processors are plugins that can execute code on certain events. For more information on those events check the [class documentation](../../ref/api/processors.rst).\n", | |||
"Processors are plugins that can execute code on certain events. For more information on those events check the [class documentation](https://nornir.readthedocs.io/en/latest/api/nornir/core/processor.html#nornir.core.processor.Processor).\n", |
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.
I actually think this should be ../api/processors.rst
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.
Thank you for the response.
Oops on my part. Sphinx auto-generated docs rather than hard-coded hyperlinks makes sense. 😅
Updated the PR with a relative link to processor.rst Edit: processors, plural 😅 |
ccdc0f1
to
3661b7d
Compare
@dbarrosop I believe this is to be fixed. |
Argh, this may need a similar fix to the other one you submitted in the other repo, not sure if you'd like to fix this one as well (it'd be very appreciated :P) |
Hello @dbarrosop I suspect the page to link to is: https://nornir.readthedocs.io/en/latest/api/nornir/core/processor.html which corresponds to https://github.com/nornir-automation/nornir/blob/main/docs/api/nornir/core/processor.rst ❓ I'm trying to regenerate the docs with sphinx so I can look at them before I push any updates. Once I correct this broken link then I will chase after the list of links I found so I can correct them too. 😉 |
Pull Request Test Coverage Report for Build 10276617225Details
💛 - Coveralls |
No worries, this was fixed already so we only had to rebase.
try doing Btw, do you want me to merge the PR or do you want to commit more changes here? |
Interesting. I fetched from your repo's main branch (July 23rd commits) and rebased my "feature" branch in the past few days.
From the commit history that steam rolled any commits I had made. Is the intent that I should lay my changes on top of the merge you made on my feature branch?
When it's ready, my thought is to merge this one and I'll build up other PR(s). |
It doesn't really matter, as long as there are no conflicts it doesn't matter if you rebase or push changes on top or whatever, we will end up squashing the commits into and keeping the history linear.
Ok, let me know when you think it's ready |
ada67a2
to
8820523
Compare
@dbarrosop Based on what I saw in the inventory tutorial I realized there were still some changes I should make. Along with that I squashed my commit history. I need to learn more about sphinx since I want to locally test before pushing code to GH. 🤔 😀 |
Thanks! |
And thank you for your patience! 😅 |
fix processors class docs hyperlink (issue #593)