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 mkdocs-material for native creation date support #518

Merged
merged 2 commits into from
May 17, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

#### Changed

- Updated mkdocs-material to 7.1.4 for native creation date support [#518](https://github.com/askap-vast/vast-pipeline/pull/518).
- Updated tests to account for relation fix [#510](https://github.com/askap-vast/vast-pipeline/pull/510).
- All file examples in docs are now enclosed in an example admonition [#494](https://github.com/askap-vast/vast-pipeline/pull/494).
- Further changes to layout of documentation [#494](https://github.com/askap-vast/vast-pipeline/pull/494).
Expand Down Expand Up @@ -91,6 +92,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

#### List of PRs

- [#518](https://github.com/askap-vast/vast-pipeline/pull/518) dep: Updated mkdocs-material for native creation date support.
- [#517](https://github.com/askap-vast/vast-pipeline/pull/517) fix: pin djangorestframework-datatables to 0.5.1.
- [#515](https://github.com/askap-vast/vast-pipeline/pull/515) fix: remove linebreaks from coordinates.
- [#514](https://github.com/askap-vast/vast-pipeline/pull/514) dep: Added created and updated dates to doc pages.
Expand Down
4 changes: 0 additions & 4 deletions docs/developing/docsdev.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@ docs/theme
│   ├── extra.js
│   ├── lg-zoom.js
│   └── lightgallery.min.js
├── partials
│   └── source-date.html
└── main.html
```

Expand Down Expand Up @@ -137,8 +135,6 @@ The following options are used:
enable_creation_date: true
```

and the HTML file `theme/partials/source-date.html` provides the extra HTML required to display the creation date.

!!! warning "Dates and Code Reference Pages"
The option `fallback_to_build_date: true` is required for the code reference pages that are auto generated by the [`mkdocs-gen-files`](https://oprypin.github.io/mkdocs-gen-files/){:target="_blank"} plugin (see the [Python Docstrings and Source Code](#python-docstrings-and-source-code) section below).
These pages will show the build date rather than the "last updated" date. During the build process the following warning will be seen, which is expected and ok to ignore:
Expand Down
22 changes: 0 additions & 22 deletions docs/theme/partials/source-date.html

This file was deleted.

Loading