Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated to sphinx 7.2.6 with setup and Makefile changes #1988

Merged
merged 4 commits into from
Dec 4, 2023

Conversation

MikeSullivan7
Copy link
Collaborator

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 via make build-docs which uses sphinx directly and does not use the setup file. The old documentation related commands and functions in setup.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.

@coveralls
Copy link

coveralls commented Dec 1, 2023

Coverage Status

coverage: 75.633%. remained the same
when pulling 15238d9 on 1961_update_sphinx
into e9e6ff4 on main.

@MikeSullivan7 MikeSullivan7 force-pushed the 1961_update_sphinx branch 4 times, most recently from 9609b79 to 5903a10 Compare December 1, 2023 16:04
Makefile Outdated Show resolved Hide resolved
@samtygier-stfc samtygier-stfc added this pull request to the merge queue Dec 4, 2023
Merged via the queue into main with commit 774a4e8 Dec 4, 2023
8 checks passed
@samtygier-stfc samtygier-stfc deleted the 1961_update_sphinx branch December 4, 2023 11:05
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.

Update sphinx
3 participants