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

c# - Validate object ID from GET to POST -

i have method allows user access comment have made on site. have post method lets them update comment. my normal solution send entire comment model through, let them update it, update on database when post back. involve sending commentid through in hiddenfor , can manipulated. how can verify commentid sent in get method same i'm getting in post , not able alter comment wish? how can verify commentid sent in method same i'm getting in post? basically have validate following things in post - user logged-in user. authenticated users post comments. commentid in post , should valid commentid , should present in database. userid associated logged-in user should same userid associated comment . comment should contain userid column, can check @ time of update. to make sure update happens comment has been sent in get - hold commentid in session , in post action compare commentid value in session .
Read more

node.js - Custom Model Validator SailsJS -

when using custom model validator checks record within model. return within spread doesn't seem end control flow. //post.js model /** * custom validator **/ types: { isuservalid: function(user_id) { var promise = require('bluebird'); promise.all([ user.findone({id: user_id}) ]) .spread(function(user) { console.log(user); if (user === null || user === undefined) { console.log('failed'); return false; }else{ console.log('passed'); return true; } }); } }, my response standard validation failed response. { "error": "e_validation", "status": 400, "summary": "1 attribute invalid", "model": "post", "invalidattributes": { "owner": [ { "rule": "isuservalid", ...
Read more

php - Find a regex to take part of Email -

i have following emails need extract part from: bestellnummer xxx: 1 von xxx, 1er pack ------------- anfang der nachricht ------------- foo bar baz foo bar baz // <<<<< need text here ------------- ende der nachricht ------------- ------------- anfang der nachricht ------------- foo bar baz foo bar baz ------------- ende der nachricht ------------- there 0 unlimited occurences of ------------- anfang der nachricht ------------- ------------- ende der nachricht ------------- and i'm able extract first part regex: $re = "/------------- .*? -------------.?(.*?).?------------- .*? -------------/s"; but, i'm quite new on learning regex, i'm pretty sure there must better regex extract part (foo bar baz foo bar baz) of text between ------------- anfang der nachricht ------------- ------------- ende der nachricht ------------- as can in different languages, i'm using .? to match between hyphens. i...
Read more