documentation - Python Sphinx anchor on arbitrary line -


how can set anchor reference @ arbitrary line in rest using sphinx?

to more clear, here example:

a title anchor ----------------------  stuff

this create heading a title anchor , add on-hover character @ end of line, anchor reference line/heading.

now in following case...

``some arbitrary line``     definition

...i want have anchor some arbitrary line, same way heading.

you can role called ref: http://sphinx-doc.org/markup/inline.html#role-ref

specifically read 2nd bullet point addresses happens if reference not placed before title.

for example, in file called example.rst how use:

.. _arbitrary-anchor:  arbitrary line     definition

the label "arbitrary-anchor" has unique through out document. reference anchor somewhere in document, this:

lorem ipsum :ref:`here anchor link <arbitrary-anchor>` dolor sit amet

unfortunately, anchor not show when hover on referenced line, should able access using explicit link http://example.com/example.html#arbitrary-anchor

since mention definitions - worth noting there role called term lets reference definition in glossary.

for example of how use this, see: http://sphinx-doc.org/glossary.html#term-role

and how referenced in 3rd paragraph of: http://sphinx-doc.org/domains.html#domains

lastly, if need insert anchor in middle of paragraph, 1 way creating explicit <a id=#sample>inline anchor</a> using raw role: http://docutils.sourceforge.net/docs/ref/rst/roles.html#raw

edit:

there 1 more option. create anchor , hover effect.

.. rst:role:: sample rst role      sample definition links anchor :rst:role:`sample rst role`

this funny looking directive i've been using while now. found when looking @ source of page:

http://sphinx-doc.org/markup/inline.html#inline-markup

http://sphinx-doc.org/_sources/markup/inline.txt

the text looks when hover: enter image description here

the text looks after click on link: enter image description here

this option less ideal because displays : left , right of definition. nice because creates anchor , hover on that's not title (so doesn't show in toc well, wanted)


Comments

Post a Comment

Popular posts from this blog

javascript - Google App Script ContentService downloadAsFile not working -

i have web app developed using google app script htmlservice , html form, populating excel sheet in google drive using spreadsheetapp . , 1 section calling contentservice download data excel file. function doget(e) { // read excel sheet //getappfile(); // render application html template return htmlservice.createtemplatefromfile('index').evaluate() .settitle('go smart') .setsandboxmode(htmlservice.sandboxmode.iframe); } function downloaddoublequatecsvfile() { var sheetid = propertiesservice.getscriptproperties().getproperty('sheetid'); var ss = spreadsheetapp.openbyid(sheetid).getactivesheet(); //var ss = spreadsheetapp.getactivespreadsheet().getactivesheet(); var maxcolumn = ss.getlastcolumn(); var maxrow = ss.getlastrow(); var data = ss.getrange(1, 1, maxrow, maxcolumn).getvalues(); if (data.length > 1) { var csv = ""; (var row = 0; row < data.length; row++) { (var c...
Read more

javascript - Function overwritting -

is there way overwrite function or event handling in function? using addeventlistener, can have many event handlers on element want var test=document.getelementbyid("div"); test.addeventlistener("click",function(){alert("im first");},false); test.addeventlistener("click",function(){alert("im second");},false); // alerts "im first" , after "im second" but if want overwrite function/event example based on client width example this function one() { alert("first"); } function two() { alert("second"); } window.onresize = function() { var test = document.getelementbyid("div"); if (window.innerwidth > 500) { test.onclick = 1 } else { test.onclick = two; } } is possible in javascript? in case use effective little known approach. addeventlistener can accept object property handleevent event handler. in case it's easy overwr...
Read more

c# - Exception when attempting to modify Dictionary -

i creating dictionary manage threads , ran exception when attempt clear dead threads after adding threads dictionary. using system; using system.collections.generic; using system.threading; namespace syscat { public class threadmanager { public static readonly threadmanager globalthreadmanager = new threadmanager( ); /// <summary> /// initializes new instance of <see cref="syscat.threadmanager"/> class. /// </summary> public threadmanager( ) { } /// <summary> /// create new threadmanager threads within basetm , deinitializes basetm /// </summary> public threadmanager( threadmanager basetm ) { this.threads = basetm.threads; basetm.threads.clear( ); } private dictionary<guid,thread> threads = new dictionary<guid, thread>( ); /// <summary> /// attempts obtain unused threadid within ...
Read more