search

hytest-org / hytest

https://hytest-org.github.io/hytest/
22 stars 10 forks source link

Fix README links in JB #287

Closed amsnyder closed 1 year ago

amsnyder commented 1 year ago

TOC points to environment_set_up/README, essential_reading/README, and evaluation/README. These are meant to provide an overview of the type of content for the whole chapter. All of these contain links to the hytest repo that we probably actually want to point to the chapter. We could make a JB-specific copy of these which will have similar information, but be tailored to the JB style and link to those chapters?

gzt5142 commented 1 year ago

I think I understand.... you want to :

The JB would NOT include the README, but would include the index. Do I have that right ?

amsnyder commented 1 year ago

That's what I'm considering...I opened this issue to track that this needs a resolution. I want to think on it a bit more.

amsnyder commented 1 year ago

But I did notice that this README with links to the repositoryis being pulled into the JupyterBook here and the links are redirecting to the JupyterBook page. Did you do something special to make this work in the current JB deployment?

gzt5142 commented 1 year ago

I'm not sure I understand the core of your question.

I did not do anything special. Jupyterbook will detect existing links and attempt to translate them to the built book. If you hard-code a link in a README (or anywhere else), the builder will translate for the book version, provided that the destination of that link appears as a document in the TOC. If the link target is not in the TOC, the link is not made.

amsnyder commented 1 year ago

Ah ok - I think I misunderstood our conversation last week. I did not realize the links would get translated to JB links if they are in the TOC.

I'm going to close this issue, and we will look for issues after we build the book with its current content.