Add page generation for pull request

[jcohenadad]

in SCT (and many other projects) we have the documentation built, that we can check on the pull request, without having to build the site locally on our computer. Example (see last check):

Would it be possible to implement such feature also for this repository?

[namgo]

This is a little tricky because if a page isn't accessible from a parent it's a warning, and setting all warnings as errors would fail a few existing pages. Maybe this is a good opportunity to fix some of the missing links.

I'll proceed with cleaning up the docs in a different PR, but https://stackoverflow.com/questions/33896196/how-to-test-the-validity-of-your-sphinx-documentation will be what makes up the basis for "make test".

Edit:

make dummy was added semi-recently, I'll check how the warning syntax looks in gh actions. Might be all I need to do.

[nullnik-0]

If I'm understanding correctly, I think the question is about having a PR preview feature similar to what is offered by Read the Docs, which allows one to preview site changes directly in pull requests, so that a local build is not needed to preview changes? If so, maybe something like Netlify would be a good solution here?

[jcohenadad]

If I'm understanding correctly, I think the question is about having a PR preview feature similar to what is offered by Read the Docs, which allows one to preview site changes directly in pull requests, so that a local build is not needed to preview changes?

yes, that's exactly it

If so, maybe something like Netlify would be a good solution here?

Only if this is not too complicated to put in place. The feature is not sooooo needed, as it's not the end of the world to build locally or to publish, and then fix later on (although this is not great practice)

[namgo]

Ooooh! That makes perfect sense, thanks @nullnik-0 !!

[nullnik-0]

@namgo and I have been talking. I've reassigned this task to myself and will look into the Netlify solution a bit more when I get a chance.