search

sfstoolbox / theory

Theory of sound field synthesis
https://sfs.readthedocs.io
Creative Commons Attribution 4.0 International
14 stars 3 forks source link

Handle visibility of permalinks #6

Closed hagenw closed 5 years ago

hagenw commented 8 years ago

If you move your mouse over one of the headings, you will see a small icon right beside them, providing the permalink to this section heading. See: http://www.sphinx-doc.org/en/stable/config.html#confval-html_add_permalinks

For equations and figures this is unfortunately not the case. But it is in my opinion absolutely necessary that every reader can get easily a link to one of the equations or figures.

For the equations, I implemented a work around with e6c149212dccb94b0466b002dafb9f81fc542035 and 838b53fe66418636a76f2f91dbc4c56869e42b1c. This works, but it is different from the headings which might let to some confusions. Also it is not obvious that you can click on the equation numbers. Another downside is that we need a modified version of mathajax.py for this.

For the figures I have no solution at the moment. There is a the possibility to modify the code in sphinx that creates the figure, but I haven't done it so far. First we should come up with a general agreement on how to handle permalinks.

hagenw commented 6 years ago

For equations this is solved by using the new KaTeX extension and some CSS fixes (d61f6bb).