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 using Docker instead of makedocs scripts #3781

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tanishiking
Copy link
Member

@tanishiking tanishiking commented Feb 18, 2024

fix? #2687

The problem seems to be setting up python dev environment locally isn't necessarily reproducible.
This PR deprecates the makedocs script that setup and build the sphinx doc, and introduce Docker to setup/build the sphinx environment so that it works in any environments.

Regarding Github Actions, I'm not sure we want to use Docker container to run sphinx

  • it's just for checking build passes with -W option
  • Running sphinx in Docker in Github Actions would requires some work (we need to build the image for every run if we don't use any cache / remote repository) and a bit of trick (?)

related #3778

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant