ci: pdf generation with docker

[numero-744]

Fix #132

I still have to add it to GitHub actions, but there is still discussion needed in #132 about this.

[numero-744]

Oooh check failed because of SpinalHDL/SpinalHDL#913, I will have update links in another PR after SpinalHDL/SpinalHDL#918 is merged

Edit: broken link removed, rebased this PR

[numero-744]

I am editing .github/workflows/push-doc.yml and I notice the redirection. I am wondering, is it possible to push a page right on https://spinalhdl.github.io/ with a redirection?

[numero-744]

I've got an error I can't fix https://github.com/numero-744/SpinalDoc-RTD/actions/runs/3472250039/jobs/5802824263

So now I try just using Docker because, well, the configuration is already here! (I try to add caching of the built docker image as well, WIP)

[numero-744]

It's alive! https://numero-744.github.io/SpinalDoc-RTD/ (but I might break this link soon XD)

I do some fixes for caching then I update this PR.

[numero-744]

Okay so for now it seems I fail with caching the docker image… But maybe it is just because cache is used only for when history goes forward so I don't know. Anyway, it is not a big deal as it is only on release, not for PRs.

[numero-744]

@wifasoi @Dolu1990 ready for review ❤️

[Readon]

Ahhh, it is not mergable now, due to the duplicated modification on README i think.

[Readon]

Why we need to change the files in .github directory when the target is just generate a pdf by docker?

[numero-744]

@Readon the conflict is fixed now.

Because the idea is to provide access to the PDF from the site like in #132 (comment) or in live demo: https://numero-744.github.io/SpinalDoc-RTD/master/

[Readon]

@Readon the conflict is fixed now.

Because the idea is to provide access to the PDF from the site like in #132 (comment) or in live demo: https://numero-744.github.io/SpinalDoc-RTD/master/

Ahhh, I guess you merged the two targets into one.

1. generate pdf with docker.
2. automatically generate & publish pdf file on corresponding website.

[numero-744]

Yes, using docker was more a way to ease setting things up (can be tested locally, really useful for debug)

[Readon]

Yes, using docker was more a way to ease setting things up (can be tested locally, really useful for debug)

Yes, docker is very good.
Except that the link to the generated pdf is hidden too deep.

However, I'm not familiar with this, so I can't give any more advice. :)

[Readon]

Maybe we can merge this first to see if there is any feedback.

[numero-744]

Except that the link to the generated pdf is hidden too deep.

This is from an unreleased feature of multiversion I was pointed to: #132 (comment)

I'm okay with it: you have a button with versions, you find old versions and different formats. But I'm working on a big refactoring of the docs (PR not open yet), I'll take it into consideration, to make this v:master button more known.

[Readon]

Except that the link to the generated pdf is hidden too deep.

This is from an unreleased feature of multiversion I was pointed to: #132 (comment)

I'm okay with it: you have a button with versions, you find old versions and different formats. But I'm working on a big refactoring of the docs (PR not open yet), I'll take it into consideration, to make this v:master button more known.

Maybe another PR is better to keep the repo's history clean.

[numero-744]

Yea, will be a really big PR on its own, no need to mix it with other things XD