Skip to content

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

Open
simonjayhawkins opened this issue May 30, 2019 · 6 comments
Open

CI: build documentation for Windows #26574

simonjayhawkins opened this issue May 30, 2019 · 6 comments
Labels
CI Continuous Integration Docs Needs Discussion Requires discussion from core team before further action Windows Windows OS

Comments

@simonjayhawkins
Copy link
Member

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:

  • should a build failure be an allowed failure?
  • should it be a separate job or included in the one of the two current windows jobs?
@simonjayhawkins simonjayhawkins added Docs CI Continuous Integration Windows Windows OS Needs Discussion Requires discussion from core team before further action labels May 30, 2019
@WillAyd
Copy link
Member

WillAyd commented May 30, 2019

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?

@simonjayhawkins
Copy link
Member Author

I think a full build on Windows would be overkill.

that's my concern. it could disrupt the current workflow.

Is there a way to just build a small part that checks the functionality without having to wait the entire thing out?

some smoke test could be a possibility or maybe just a nightly job on a full build would suffice.

@jreback
Copy link
Contributor

jreback commented May 30, 2019

actually we have an issue about building the docs on azure

wouldn’t mind having a linux and a windows build
(we can push from just the linux one)

if it’s easier to have a quick windows build that’s fine too (eg maybe be a partial build)

@jorisvandenbossche
Copy link
Member

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).

@datapythonista
Copy link
Member

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 s/script/bash in the azure configuration, but seems like the azure Windows bash doesn't support everything we're doing, so it'll require a bit more work.

The issue for unifying that would be #26344.

@afeld
Copy link
Member

afeld commented Jan 16, 2021

👋 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs Needs Discussion Requires discussion from core team before further action Windows Windows OS
Projects
None yet
Development

No branches or pull requests

6 participants