issues: 1124431593

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
1124431593 PR_kwDOAMm_X84yGFBx 6237 Enable running sphinx-build on Windows 38358698 closed 0     7 2022-02-04T17:15:14Z 2022-03-04T19:15:42Z 2022-03-01T16:00:34Z CONTRIBUTOR   0 pydata/xarray/pulls/6237
  • [x] User visible changes (including notable bug fixes) are documented in whats-new.rst

This PR enables one to build the documentation on Windows by manually invoking sphinx-build.

The first commit enables sphinx to execute the "conf.py" file. Before the commit, sphinx complains:

Configuration error: There is a programmable error in your configuration file:

with the exception FileNotFoundError: [WinError 2] The system cannot find the file specified where it tries to invoke conda. On Windows, conda environments other than the base environment have "conda.bat" on their path rather than "conda.exe", and one must call subprocess.run with "conda.bat" instead of merely "conda". However, the CONDA_EXE environment variable correctly points to the executable and should do so across platforms; it requires conda version 4.5 or later for conda/conda#6923.

The second commit enables the build to tolerate exceptions when deleting temporary files and tells Git to ignore more such files. Without the commit, builds occasionally failed at the os.remove calls with exceptions such as PermissionError: [WinError 32] The process cannot access the file because it is being used by another process: 'example.nc'.

Should "whats-new.rst" mention these changes, which are developer-visible but not user-visible?

I welcome any feedback.

Edit: Checked the "whats-new" task.

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/6237/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 pull

Links from other tables