-
-
Notifications
You must be signed in to change notification settings - Fork 264
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
Convert All Documentation Links to Relative Path Links #713
Conversation
Convert all documentation links to relative path links. This way they also work in local documentation. A few broken links were also found and fixed. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. A few broken links were also found and fixed. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. The only converted link was also originally broken due to a typo, which has been fixed after conversion. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. I also found the only converted link was originally broken due to a typo, which has also been fixed. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. A few broken links were also found and fixed. Signed-off-by: Yifeng Li <tomli@tomli.me>
Convert all documentation links to relative path links. This way they also work in local documentation. There is a direct reference to https://scikit-rf.readthedocs.io as the documentation site, which is preserved as-is. Signed-off-by: Yifeng Li <tomli@tomli.me>
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.
nice and useful fixes!
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.
Cool! Did you build the docs locally and checked if there are any warnings related to these changes? (There are all sorts of warnings, unfortunately, but maybe you can have a quick glance.)
I did. After the documents are changed, I tried building the docs repeatedly while watching for any warning from the console. I also tried clicking all the links in my local browser. It took me quite some minutes to figure out the correct syntax for all the links. Now the only warning seems to be (this is from the CI but it's consistent with what I've seen):
I don't understand what's going on. But I believe this warning already existed before the link change and it's unrelated. I don't notice other warnings otherwise. Still, it's all manual changes and manual testing. So it's possible that I've missed something. |
This PR converts all documentation links to relative path links. This way they also work in local documentation. A few broken links were also found and fixed.
P.S: I also noticed that there is a direct reference to https://scikit-rf.readthedocs.io/ in contributing/index.rst as the project's documentation site, which was not mindlessly converted, it's preserved as-is as it should.