Use version number in file links in Sphinx -

-

in sphinx, file links can generated using following syntax:

`name_of_file.js <some/location/name_of_file.js>`_

in conf.py file, version variable defined can use in .rst files such:

|version|

including version file link using syntax not allowed:

`name_of_file.|version|.min.js <some/location/name_of_file.|version|.min.js>`_

so, how can generate links files named name_of_file.<version_num>.min.js , use version number conf.py?

i had need similar , after experimentation have workaround this. warned, crummy solution works.

the short answer:

you need split parts of link left , right of |version| , use raw html along |version|. .rst this:

example of link version in |link-pre|\ |version|\ |link-post|  .. |link-pre| raw:: html      <a href="some/location/name_of_file.  .. |link-post| raw:: html      .min.js">name_of_file.min.js</a>

the long answer

there couple of hurdles need overcome:

problem 1: now, |version| substitution definition. when use substitution reference in document, has lead space |version|.

so in regular rst sentence, not link, can't name_of_file.|version|.min.js. need name_of_file.\ |version|.min.js, i.e, escape space \

problem 2: nested inline markup not supported in rest: http://docutils.sourceforge.net/faq.html#is-nested-inline-markup-possible

so can't make substitution, |version|, within link \`name_of_file.|version|.min.js`\. why have use raw-html , break parts, , create 2 more substitution definitions |link-pre| , |link-post|, replaced raw-html in generated output.

i tried using inline :raw-html: role did not help, unfortunately solution turned out verbose.


Comments

Post a Comment

Popular posts from this blog

swift - How to change text of a button with a segmented controller? -

-
i have button links view control. trying change text of button segmented control. using jared davidson tutorial on segmented controls changing text of labels . how change text of button? also, when attempted japanese characters, got error on line: "invalid character in source file". thank you! you can change button title japanese characters way: yourbutton.settitle("ボタンのタイトル", forstate: uicontrolstate.normal)
Read more

python - How to create jsonb index using GIN on SQLAlchemy? -

-
here's current code creating index jsonb. index("mytable_data_idx_id_key", mytable.data['id'].astext, postgresql_using='gin') but got error. sqlalchemy.exc.programmingerror: (psycopg2.programmingerror) data type text has no default operator class access method "gin" hint: must specify operator class index or define default operator class data type. [sql: "create index event_data_idx_id_key on event using gin ((data ->> 'id'))"] is there way create index on sqlalchemy? the postgresql specific sqlalchemy docs @ http://docs.sqlalchemy.org/en/latest/dialects/postgresql.html#operator-classes mention postgresql_ops dictionary provide "operator class" used postgresql, , provide example illustrating use: index('my_index', my_table.c.id, my_table.c.data, postgresql_ops={ 'data': 'text_pattern_ops', ...
Read more

PHP DOM loadHTML() method unusual warning -

-
i had following code works fine on localhost: $document = new domdocument(); $document->loadhtml($p_result); $form = $document->getelementsbytagname('form')->item(0); // code continues using $form variable after same code updated on outside server, loadhtml() failed , issued warning. warning: domdocument::loadhtml() expects parameter 1 valid path, string given in path/name/to/script.php returned null instead of object code pretty gets fatal error. note contents of $p_result absolutely same on outside server , on localhost. but why displays kind of warning , why not work? doesn't loadhtml() expects argument 1 string in first place? why method expects parameter 1 valid path ? just make clear i'm not calling loadhtmlfile() , i'm calling loadhtml() . thanks. you're affected one of php bugs . issue present in php 5.6.8 , 5.6.9. have affected php version on server, , bug-free version on localhost. the bug forbids null ...
Read more