-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
CI: build documentation for Windows #26574
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
Comments
I think a full build on Windows would be overkill. Is there a way to just build a small part that checks the functionality without having to wait the entire thing out? |
that's my concern. it could disrupt the current workflow.
some smoke test could be a possibility or maybe just a nightly job on a full build would suffice. |
actually we have an issue about building the docs on azure wouldn’t mind having a linux and a windows build if it’s easier to have a quick windows build that’s fine too (eg maybe be a partial build) |
We could certainly build a part (like a single page) to at least catch errors in the general sphinx configuration (that will not catch windows-specific errors in all code examples though). |
I did some tests on this and most of the changes are somehow simple. I have this PR in my fork that shows what it involves: https://github.com/datapythonista/pandas/pull/10/files The only requirement would be to unify the environment set up between windows and Linux/mac. I tried a simple The issue for unifying that would be #26344. |
👋 Relatively new docs contributor here. I think it's very reasonable to have an opinionated development setup, e.g. "Want to contribute? Use the Docker setup." Folks that want something different can set that up, since they will probably want something customized anyway. |
xref #26499 (comment)
documentation is a good place to start for new contributors.
should a doc build be included in CI to ensure that the documentation builds smoothly on Windows?
if so:
The text was updated successfully, but these errors were encountered: