Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build docs in PRs ? #126

Closed
Carreau opened this issue Jan 24, 2024 · 7 comments
Closed

Build docs in PRs ? #126

Carreau opened this issue Jan 24, 2024 · 7 comments
Labels
enhancement New feature or request

Comments

@Carreau
Copy link
Collaborator

Carreau commented Jan 24, 2024

It looks to me that docs are not build in PRs,
I'm not sure how they are supposed to be build, but locally I had to change a couple of things like yml to yaml for things to build.

Maybe we should have a workflow checking that our docs build properly ?

@Carreau Carreau added the enhancement New feature or request label Jan 24, 2024
@martinRenou
Copy link
Member

As far as I understand it is being built, for example with your PR #128 the built doc is https://jupyterlite-sphinx--128.org.readthedocs.build/en/128

@martinRenou
Copy link
Member

Read the docs reports the doc build as part of the CI checks

@Carreau
Copy link
Collaborator Author

Carreau commented Jan 24, 2024

Yeah, but in case of failure, you can't see the logs as far as I Can tell.

@martinRenou
Copy link
Member

In case of failure, it should mark the check with a red cross and clicking on it should show you the logs.

@jtpio
Copy link
Member

jtpio commented Jan 24, 2024

In case of failure, it should mark the check with a red cross and clicking on it should show you the logs.

Yes, for example:

@Carreau
Copy link
Collaborator Author

Carreau commented Jan 24, 2024

Ah, thanks you are right. Feel free to close. I still have the impression that GitHub action is a bit more open into how docs are tested. Can readthedocs full configuration be in a readthedocs.yml file so that we can see how it tests docs ?

@martinRenou
Copy link
Member

The readthedocs configuration is at the root: https://github.com/jupyterlite/jupyterlite-sphinx/blob/main/.readthedocs.yml

@Carreau Carreau closed this as completed Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants