You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The version specified in the documentation is provided by the Sphinx
config in `docs/conf.py`.
This duplicates the version specified in `hazelcast/init.py`, and
previously [became
outdated](#690).
Unfortunately, in this PR I updated the version incorrectly (i.e. to
`5.4.0`, not `5.5.0`), highlighting the issues with duplicating this
data.
Instead, we should have a single place the version if specified, and
reference it in the Sphinx config.
Example output following this change:
<img width="898" alt="image"
src="https://github.com/user-attachments/assets/36718c1f-fdfc-406c-bbf8-31d9ac207ff5">
In addition, while trying to build the documents locally, `make html`
failed with a cryptic error message:
> *** commands commence before first target. Stop.
I didn't have Sphinx installed, and while `make` was happy to evaluate
the `if` check for it's existence, printing an error message was
disallowed outside of a target. Fixed by adding a target, and requiring
that on any Sphinx related targets.
This can be tested by updating the `SPHINXBUILD` command to something
that doesn't exist and trying to build the documentation:
> % make html
Makefile:13: *** The 'non-existant-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
'non-existant-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.
Copy file name to clipboardExpand all lines: docs/Makefile
+28-27Lines changed: 28 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,8 @@ SPHINXBUILD = sphinx-build
7
7
PAPER =
8
8
BUILDDIR = _build
9
9
10
-
# User-friendly check for sphinx-build
10
+
.PHONY: check-sphinx
11
+
check-sphinx:
11
12
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
13
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' 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/)
13
14
endif
@@ -54,44 +55,44 @@ clean:
54
55
rm -rf $(BUILDDIR)/*
55
56
56
57
.PHONY: html
57
-
html:
58
+
html: check-sphinx
58
59
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS)$(BUILDDIR)/html
59
60
@echo
60
61
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
0 commit comments