Adding link back to table of contents

[dannyduncan]

Within the jupyterbook framework, I'm attempting to to add a link back to the table of contents after rendering using latex. This is not really working for me using standard internal linking methods [name of link](name of .md or .ipynb document)

Much appreciate any help that anyone can provide.

[choldgraf]

ah so you wish to have a link to the table of contents within the PDF itself? Perhaps @mmcky has experience with this?

[dannyduncan]

@choldgraf yes that's correct!

[mmcky]

hi @dannyduncan -- I just tried adding

[toc](intro.md)

for a project where the first - file: intro is specified in the _config.yml and it links to the bottom of that page in latex and not particularly useful.

In sphinx (which is what we use under the hood to build the html) there is the option to use :name: on the toctree directive for use with ref. @choldgraf perhaps we should add a default label name for the global toc that could make it able to be referenced?

[dannyduncan]

@mmcky yes I think adding the name would make referencing possible. Please let me know if there's anything I can help with here.

[mmcky]

this pr looks to resolve this issue by adding a globaltoc label for the masterdoc -- however the placement of the toctree in the xml is currently an issue linking to the bottom of content placed in the first document of a project.

Current latex output

...
\pagestyle{empty}
\sphinxmaketitle
\pagestyle{plain}
\sphinxtableofcontents
\pagestyle{normal}
\phantomsection\label{\detokenize{intro::doc}}


This is the frontmatter

\phantomsection\label{\detokenize{intro:globaltoc}}
...

but needs to be:

\pagestyle{empty}
\sphinxmaketitle
\pagestyle{plain}
\phantomsection\label{\detokenize{intro:globaltoc}}
\sphinxtableofcontents
\pagestyle{normal}
\phantomsection\label{\detokenize{intro::doc}}


This is the frontmatter

[mmcky]

@mmcky yes I think adding the name would make referencing possible. Please let me know if there's anything I can help with here.

@dannyduncan unfortunately it seems that adding a :name: is ignored by the sphinx latex writer. I guess because it relies on latex to generate the table of contents.

[dannyduncan]

@mmcky that's unfortunate but thank you for trying to accomplish a workaround!

[mmcky]

@dannyduncan I have noted this a feature request and will add it to our work on LaTeX templates and making improvements to the PDF output.