Skip to content

Fix Makefile when sphinx is not available#451

Merged
joshmoore merged 2 commits intozarr-developers:mainfrom
mkitti:mkitti/sphinx
Jul 18, 2023
Merged

Fix Makefile when sphinx is not available#451
joshmoore merged 2 commits intozarr-developers:mainfrom
mkitti:mkitti/sphinx

Conversation

@mkitti
Copy link
Contributor

@mkitti mkitti commented Jul 18, 2023

Fix #450, cryptic error when sphinx is not in environment

Before this pull request:

~$ cd src/numcodecs/docs

~/src/numcodecs/docs$ make
Makefile:12: *** recipe commences before first target.  Stop.

~/src/numcodecs/docs$ make html
Makefile:12: *** recipe commences before first target.  Stop.

After this pull request:

~$ cd src/numcodecs/docs

~/src/numcodecs/docs$ make
Makefile:14: *** The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/.  Stop.

~/src/numcodecs/docs$ make html
Makefile:14: *** The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/.  Stop.
  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@joshmoore
Copy link
Member

joshmoore commented Jul 18, 2023

Interesting. This file is code-generated by sphinx itself. I wonder what a newer version would look like. In any event, thanks for the fix, @mkitti. Jobs running.

@joshmoore joshmoore merged commit 7746737 into zarr-developers:main Jul 18, 2023
@jakirkham
Copy link
Member

Yeah might be worth submitting an upstream issue

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cryptic error when trying to build docs without sphinx installed

3 participants