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

Remove versions.json and related configuration #3556

Merged
merged 4 commits into from
Nov 25, 2023

Conversation

agriyakhetarpal
Copy link
Member

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@agriyakhetarpal
Copy link
Member Author

I had updated our project on Read the Docs to use the new beta features, which means we get a version warning bar by default, on

  1. http://docs.pybamm.org/en/latest – the latest unreleased version
  2. https://docs.pybamm.org/en/v23.4.1/ – and other older versions.

We use the version switcher from Read the Docs, so I don't think we need this versions.json file anymore.

@agriyakhetarpal
Copy link
Member Author

I also added a new white text PyBaMM logo: it is the same one we currently use for the footer in the https://pybamm.org/ website and should be good for accessibility when browsing the documentation in dark mode.

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Looks good, thanks, @agriyakhetarpal!

Copy link

codecov bot commented Nov 25, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2ee8da2) 99.58% compared to head (6ed478b) 99.58%.
Report is 106 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3556   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          256      256           
  Lines        20126    20126           
========================================
  Hits         20043    20043           
  Misses          83       83           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Saransh-cpp Saransh-cpp merged commit d8f3b73 into pybamm-team:develop Nov 25, 2023
33 of 35 checks passed
@agriyakhetarpal agriyakhetarpal deleted the remove-versions.json branch November 25, 2023 19:31
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.

2 participants