Updated to sphinx 7.2.6 with setup and Makefile changes #1988
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.
Issue
Closes #1961 and progresses #1981
Description
Sphinx has been updated to the newest version 7.2.* (7.2.6 currently).
The documentation is no longer built via
python setup.py docs
but is now done viamake build-docs
which uses sphinx directly and does not use the setup file. The old documentation related commands and functions insetup.py
have been deleted to progress moving away from using the setup file. The setup file is still required to publish the docs and create release notes, etc.Note: This was required as from Sphinx 7 onwards
sphinx.setup_command.BuildDoc
is depreciated.Testing
Test that the documentation still builds correctly.
Acceptance Criteria
Delete the docs/build folder and then run
make build-docs
. Once done, the documentation should build as it did before in the docs/build folder.