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

Update developer ymls for sphinx bootstrap theme #34596

Merged
merged 1 commit into from
Oct 21, 2022

Conversation

sf1919
Copy link
Contributor

@sf1919 sf1919 commented Oct 21, 2022

Description of work.

This changes the pinning of the sphinx bootstrap theme in the developer .yml files. We need to upgrade it to a more recent version to try and resolve problems with the website (see #34584 ) for more details.

To test:

  1. After pulling the branch update your conda environment e.g. for Windows you might run conda env update -f mantid-developer-win.yml --prune
  2. Delete the docs folder in your build folder (the ensure a clean version)
  3. Do a CMake build
  4. Build the docs
  5. Try looking at different pages including at least one algorithm page with maths equations (e.g. Rebin or Discus Multiple Scattering). Pages should render correctly without error
  6. Use the search box in the top right hand corner of the page. This should work with no issues.

I'm not sure this requires a release note as it is a change to developer .yml files. What do you think @martyngigg ?


Reviewer

Please comment on the following (full description):

Code Review
  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
Functional Tests
  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

- this is a part fix towards resolving #34584
@sf1919 sf1919 added Documentation Issues and pull requests related to documentation ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS labels Oct 21, 2022
@sf1919 sf1919 added this to the Release 6.6 milestone Oct 21, 2022
@martyngigg martyngigg self-assigned this Oct 21, 2022
@martyngigg
Copy link
Member

I agree that this doesn't need a release note.

Copy link
Member

@martyngigg martyngigg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can confirm that with this config I can build the HTML and the search functionality is now working again.

I'll build locally and push an update to the website so users see this sooner.

@thomashampson thomashampson merged commit dfa6d37 into main Oct 21, 2022
@thomashampson thomashampson deleted the update_sphinx_bootstrap_theme branch October 21, 2022 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants