doc: Fix broken links in getting_started#5591
doc: Fix broken links in getting_started#5591nashif merged 1 commit intozephyrproject-rtos:masterfrom
Conversation
Fix broken links in getting_started. We now use "Implicit Hyperlink Targets" instead of :ref:. I don't know why :ref: wasn't working. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
Codecov Report
@@ Coverage Diff @@
## master #5591 +/- ##
=======================================
Coverage 52.26% 52.26%
=======================================
Files 430 430
Lines 41100 41100
Branches 7810 7810
=======================================
Hits 21481 21481
Misses 19106 19106
Partials 513 513Continue to review full report at Codecov.
|
dbkinder
left a comment
There was a problem hiding this comment.
@nasif @SebastianBoe Not sure why this change was made? The existing links on http://docs.zephyrproject.org/getting_started/getting_started.html are working as expected?
|
@dbkinder : When I clicked either of these links I was redirected to the top of the page instead of to the section. I can't explain that you observed them as working as expected. |
|
That's odd. It works fine with firefox on my Linux box, but not with chrome on Windows. Hmmm. I'll look into this a bit more. |
|
So the real problem is different browser behavior when linking to an empty tag. When you place a label in a document |
|
@SebastianBoe problems caused by empty span tags is fixed in jquery 3.2.1 (yea!). (jquery/jquery#3167) I'll work on getting the new version of jquery into the doc system. |
The jquery provided by Sphinx 1.5.5 has a bug dealing with the coordinates returned for offset().top for empty <span> tags, generated by Sphinx for intra-document labels used to create hyperlink anchor targets. As reported in PR #5591, some browsers (chrome for example) don't scroll to the right spot in the document when we link to these intra-document label points. jquery v3.1.2 fixes this. (When Sphinx updates the jquery included in its release, we can remove our copy that is overriding the copy installed in the generated output by Sphinx.) Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix broken links in getting_started. We now use "Implicit Hyperlink
Targets" instead of :ref:. I don't know why :ref: wasn't working.
Signed-off-by: Sebastian Bøe sebastian.boe@nordicsemi.no