Docs external toc #122
Docs external toc #122
Conversation
There was a problem hiding this comment.
Thanks for writing this documentation. I have a few remarks.
It's probably easier to merge TeachBooks/TeachBooks#59 first and then update some of the info (e.g. links) here again.
Co-authored-by: Bart Schilperoort <b.schilperoort@gmail.com>
Co-authored-by: Bart Schilperoort <b.schilperoort@gmail.com>
Co-authored-by: Bart Schilperoort <b.schilperoort@gmail.com>
|
|
||
| Previously, this book feature was implemented using [submodules](../external/Nested-Books/README.md), but the implementation was more difficult to use. Despite this, submodules are still a widely used Git feature that can be very useful for book authors, so check out the [submodules page](../external/Nested-Books/README.md) to learn more, especially if the External TOC tool does not satisfy your needs. | ||
|
|
||
| ```{warning} |
There was a problem hiding this comment.
this should be updated once the deploy book workflow uses teachbooks>=0.2.0.
@Tom-van-Woudenberg do you just test this by running it in a fork a few times?
I made an Issue here #130
There was a problem hiding this comment.
@rlanzafame, I don't understand what you mean? As soon as the external_toc thing is in main of taechbooks let's just directly publish it to a new version. After that, the deploy book workflow will make use of it.
There was a problem hiding this comment.
it's not so simple:
- new books will use it as soon as it is released
- existing books will use it once the CI cache expires (is this after 1 week of not being used???)
- books not using our workflow don't have to worry about it
- unclear if anyone actually uses teachbooks to build books without our deploy-book-workflow, but this group would also be affected as they would be the most likely people to be building primarily locally. however, i think my last changes in PR 59 will prevent this being an issue
There was a problem hiding this comment.
I know all of that and I think we argee that we shouldn't publish it as long as it affects the previous behaviour. But there's no change in behaviour as long as there's no external: in the toc right?
There was a problem hiding this comment.
Correct. At least for the use case of GitHub Actions!
To be merged whenever external toc is released in teachbooks.
See built book page here: https://teachbooks.io/manual/docs_external_toc/features/external_toc.html