Skip to content

doc: Fix broken links in getting_started#5591

Merged
nashif merged 1 commit intozephyrproject-rtos:masterfrom
SebastianBoe:fix_links_in_getting_started
Jan 8, 2018
Merged

doc: Fix broken links in getting_started#5591
nashif merged 1 commit intozephyrproject-rtos:masterfrom
SebastianBoe:fix_links_in_getting_started

Conversation

@SebastianBoe
Copy link
Copy Markdown
Contributor

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

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>
@SebastianBoe SebastianBoe requested a review from dbkinder January 8, 2018 12:27
@codecov-io
Copy link
Copy Markdown

Codecov Report

Merging #5591 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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      513

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7817622...6836e18. Read the comment docs.

@nashif nashif merged commit cedfa9b into zephyrproject-rtos:master Jan 8, 2018
Copy link
Copy Markdown
Contributor

@dbkinder dbkinder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

@SebastianBoe
Copy link
Copy Markdown
Contributor Author

@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.

@dbkinder
Copy link
Copy Markdown
Contributor

dbkinder commented Jan 8, 2018

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.

@dbkinder
Copy link
Copy Markdown
Contributor

dbkinder commented Jan 8, 2018

So the real problem is different browser behavior when linking to an empty tag. When you place a label in a document .. label_here: the HTML that's generated by Sphinx is <span id="label-here"></span>. Technically, spans need to have some content in them, and if there were, the browsers behave the same. For us, this means you can use :ref: syntax if you use the name of the heading rather than the name of the label (e.g., don't bother with adding a label). Your patch to simply use ReST linking does the same thing in this case, so we're good.

@dbkinder
Copy link
Copy Markdown
Contributor

@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.

nashif pushed a commit that referenced this pull request Jan 15, 2018
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>
nashif pushed a commit that referenced this pull request Jun 18, 2018
With the update to Sphinx, we no longer need to provide our own updated
version of jquery.js (update is now part of the Sphinx release).

See #5591 and #5618

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants