Upgrade version in documentation #690
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The latest `hazelcast-python-client` release is `5.4.0`, but the Sphinx configuration has not been updated so it's still labelled `5.3.0` in the documentation.
srknzl
approved these changes
Aug 2, 2024
JackPGreen
added a commit
to JackPGreen/hazelcast-python-client
that referenced
this pull request
Aug 2, 2024
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](hazelcast#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: 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.
JackPGreen
added a commit
that referenced
this pull request
Aug 2, 2024
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The latest
hazelcast-python-clientrelease is5.4.0, but the Sphinx configuration has not been updated so it's still labelled5.3.0in the documentation.Post Merge: