Skip to content

Enh/add date modified documentation#559

Merged
PGijsbers merged 7 commits intodevelopfrom
enh/add_date_modified_documentation
Jul 1, 2025
Merged

Enh/add date modified documentation#559
PGijsbers merged 7 commits intodevelopfrom
enh/add_date_modified_documentation

Conversation

@Taniya-Das
Copy link
Collaborator

@Taniya-Das Taniya-Das commented Jun 30, 2025

Change

Add the last modified date in the documentation footer.

How to Test

Test locally using python -m mkdocs serve.
Note: The changes are pulled from the last git commit.

Checklist

  • Tests have been added or updated to reflect the changes, or their absence is explicitly explained.
  • Documentation has been added or updated to reflect the changes, or their absence is explicitly explained.
  • A self-review has been conducted checking:
    • No unintended changes have been committed.
    • The changes in isolation seem reasonable.
    • Anything that may be odd or unintuitive is provided with a GitHub comment explaining it (but consider if this should not be a code comment or in the documentation instead).
  • All CI checks pass before pinging a reviewer, or provide an explanation if they do not.

Related Issues

@Taniya-Das Taniya-Das marked this pull request as ready for review June 30, 2025 13:55
@Taniya-Das Taniya-Das requested a review from PGijsbers June 30, 2025 13:55
Copy link
Contributor

@PGijsbers PGijsbers left a comment

Choose a reason for hiding this comment

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

If possible, can we also add some text? E.g., "Last modified {timestamp}"? Then it is clearer for the user what it means. If that's not possible then I guess this is fine. We can maybe add a post-processing step at a later time.

@Taniya-Das
Copy link
Collaborator Author

Taniya-Das commented Jul 1, 2025

If possible, can we also add some text? E.g., "Last modified {timestamp}"? Then it is clearer for the user what it means. If that's not possible then I guess this is fine. We can maybe add a post-processing step at a later time.

To achieve this, we would likely need a custom template override or post-processing step. Since it's not straightforward, and the custom template I tried did not work as expected, I’ll revisit this later.

@PGijsbers PGijsbers merged commit 52a541a into develop Jul 1, 2025
4 checks passed
@PGijsbers PGijsbers deleted the enh/add_date_modified_documentation branch July 1, 2025 13:03
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