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

Display when pages were last updated in the docs #3089

Merged

Conversation

agriyakhetarpal
Copy link
Member

Description

Adds the sphinx-last-updated-by-git extension to display last-updated dates at the end of a source page

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 (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
  • The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

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

@Saransh-cpp
Copy link
Member

From the referenced issue, I am assuming this isn't working at the moment?

@agriyakhetarpal
Copy link
Member Author

Yes. I also scoped out other projects for the same functionality, but they are not maintained actively. This extension looks like the best option

@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (5e28bb9) 99.71% compared to head (c494873) 99.71%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3089   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files          248      248           
  Lines        18749    18749           
========================================
  Hits         18695    18695           
  Misses          54       54           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@agriyakhetarpal agriyakhetarpal marked this pull request as ready for review July 4, 2023 15:34
for the CI only, local users do not get this warning
@valentinsulzer valentinsulzer merged commit d26449f into pybamm-team:develop Jul 5, 2023
@agriyakhetarpal agriyakhetarpal deleted the sphinx-last-updated-by-git branch July 5, 2023 12:09
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.

3 participants