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.

Sign up for GitHub

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

Jump to bottom

Updated mkdocs-material for native creation date support #518

Merged
merged 2 commits into from
May 17, 2021
Merged

Updated mkdocs-material for native creation date support #518

merged 2 commits into from
May 17, 2021

Conversation

ajstewart
Copy link
Contributor

While working on vast-tools I noticed mkdocs-material was updated to natively support the creation date. So there's no need for the HTML override.

Some other packages have also been updated:

  • Updating typing-extensions (3.7.4.3 -> 3.10.0.0)
  • Updating six (1.15.0 -> 1.16.0)
  • Updating django (3.2 -> 3.2.2)
  • Installing matplotlib-inline (0.1.2)
  • Updating pygments (2.8.1 -> 2.9.0)
  • Updating greenlet (1.0.0 -> 1.1.0)
  • Updating ipython (7.22.0 -> 7.23.1)
  • Updating pymdown-extensions (8.1.1 -> 8.2)
  • Updating flake8 (3.9.1 -> 3.9.2)
  • Updating mkdocs-gen-files (0.3.1 -> 0.3.2)
  • Updating mkdocs-git-revision-date-localized-plugin (0.9 -> 0.9.2)
  • Updating mkdocs-material (7.1.3 -> 7.1.4)
  • Updating sqlalchemy (1.4.11 -> 1.4.14)

@ajstewart ajstewart added the documentation Improvements or additions to documentation label May 10, 2021
@ajstewart ajstewart requested a review from marxide May 10, 2021 14:47
@ajstewart ajstewart self-assigned this May 10, 2021
@marxide marxide merged commit 3d887b2 into dev May 17, 2021
@marxide marxide deleted the mkdocs-material-update branch May 17, 2021 16:55
marxide added a commit that referenced this pull request May 21, 2021
@marxide @dependabot
@ajstewart @shiblisaleheen
Release v1.0.0 (#539)
d8577b4 
* Bump y18n from 3.2.1 to 3.2.2

Bumps [y18n](https://github.com/yargs/y18n) from 3.2.1 to 3.2.2.
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/commits)

Signed-off-by: dependabot[bot] <[email protected]>

* Add epoch based association clarification to documentation

* .env file text and dark mode

- Added dark mode to docs.
- Added text about the .env file to documentation.
- Clarified and made clearer the Django Q requirement for running jobs.

* Changed VAST logo to icon format to not appear stretched

* Apply suggestions from code review

Co-authored-by: Andrew O'Brien <[email protected]>

* Bump minimum mkdocs-material to 7.1.1 to ensure dark mode functionality

* Updated CHANGELOG.md

* Fixed CHANGELOG.md

* Updated the docs layout, home page and FAQs

- Enabled a new home page with wave design and announcement bar.
- Changed layout to tabs and sections mode.
- Changed location of some pages to other tab headings.
- Added to FAQ section.

* Updated CHANGELOG.md

* Moved CSS to own stylesheet file

- Fixed Safari image width

* align bokehJS and bokeh python versions (#489)

* align bokehJS and bokeh python versions
Fixes #488

* added comment for bokeh to pyproject.toml

* replace run config .py files with .yaml (#483)

* replace run config .py files with .yaml
Changes the pipeline run configuration file format to YAML.
Implements a strict YAML validator.
Closes #479.

* update docs

* updated CHANGELOG

* Add pipeline/config.py to code reference nav.

* Fix UI arrow file set to False.

* Apply suggestions from code review

Co-authored-by: Adam Stewart <[email protected]>

* docs and docstring fixes

* improve pipeline config error messages

* background section always given in run config
Run config template will now always contain the background section. If source monitoring is off, it will be commented out.

* more specific run config validation messages

* lock deps

Co-authored-by: Adam Stewart <[email protected]>
Co-authored-by: Adam Stewart <[email protected]>

* Added announcement bar update step to making a release doc

* Fix bokeh hover tool for lightcurve plots (#493)

* fix missing lightcurve hovertool for non-variables

* add default x-range of 1 day to lightcurve

* updated CHANGELOG
Fixes #490

* Added lightgallery support

* Complete lightgallery support and more

* Fixed docstring in config.py.
* Updated all image captions.
* Split off `DataTables` and `Tags and Favourites` to their own pages.
* Expanded documentation of the documentation.
* Enclosed all file examples in example admonition.
* Renamed docs/quickstart -> docs/gettingstarted.
* Added acknowledgements page.
* Moved FAQs to before Reference.
* Fixed MathJax and instant navigation.

* fix broken cone search when coord = 0 (#501)

* fix broken cone search when coord = 0
Fixes #495

* updated CHANGELOG

* Change arrow file generation from vaex to pyarrow

* Removed vaex dependency.
* Removed UI warnings of arrow files not being generated when the run is processed via the website.
* Updated docs.

Fixes #497.

* Minor fixes

* added cos(dec) scaling to aladin lite footprint (#502)

* Renamed FAQs -> FAQ



* Added missing lightgallery css and js files



* Added "Relations False Variability" section to association page



* fix "back to top" TOC link

The code to add a "back to top" link to the table of contents would fail with an error message on pages that don't have a TOC.
The link was also never added if the user started on a page without a TOC as the mkdocs-material instant loading feature prevents JS from being executed when navigating between local docs pages. This patch ensures the link is always added.

* Update docs/design/association.md

Co-authored-by: Andrew O'Brien <[email protected]>

* set default auto field model (#507)

* set default auto field model
Silences warnings introduced in Django 3.2. Closes #505.
 since this doesn't change the model, it only tells Django what it already is.

* updated CHANGELOG

* Add glob expression support to yaml run config (#504)

* added support for globs in yaml run config
Input files can be specified with one or more glob expressions. See docs for details.
Resolved input file paths are matched and printed to the run log.
Closes #485
updated changelog

* fixed missing background images from run log

* wrap config snippets in example admonishment

Apply suggestions from code review.

Co-authored-by: Adam Stewart <[email protected]>

* add docstring and fix docs

* fix outdated ref in tests docs

Co-authored-by: Adam Stewart <[email protected]>

* add tmate action debugging (#512)

Enable by triggering a manual test run. See https://github.com/marketplace/actions/debugging-with-tmate


* Revert "add tmate action debugging (#512)" (#513)

This reverts commit 836e5a6.

* Draw selected source components on top in JS9 (#508)

* Draw selected source components on top in JS9
Fixes #200
 no changes covered by tests

* update changelog


* changed to single JS9 shape layer
JS9 only allows the top shape layer to respond to mouse events. Reverted
back to a single layer with the shapes internally ordered.


* Fix rogue relations (#510)

- Fixed rogue relations
- Fixed docstring typos.
- Replace deprecated pandas kwarg
- Update expected regression test data
- Updated changelog to reflect test changes
- Refactored test_most_relations() to sort by relations and RA.

Co-authored-by: Andrew O'Brien <[email protected]>

* Added created and updated dates to doc pages. (#514)

* Added mkdocs-git-revision-date-localized-plugin to docs

* Added date created to pages with override

- Also changed docs workflow to fetch with fetch-depth: 0.

* Updated CHANGELOG.md

* Updated documentation docs page

* Corrected tree on docs page

* remove linebreaks from coordinates (#515)

* remove linebreaks from coordinates
Removes the excess whitespace between the lat and lon coordinates which was being included in the clipboard copy text.


* pin djangorestframework-datatables to 0.5.1 (#517)

* pin djangorestframework-datatables to 0.5.1
Later versions give the wrong total number of results during pagination. It only seems to affect cases when a different model is paginated, e.g. the list of measurements of a run returned by views.RunViewSet.measurements.


* update doc related to default dev branch (#521)

* update doc related to default dev branch

Co-authored-by: Andrew O'Brien <[email protected]>

* Fixed external search results table nan values (#523)

Co-authored-by: Andrew O'Brien <[email protected]>

* Updated mkdocs-material for native creation date support (#518)

Co-authored-by: Andrew O'Brien <[email protected]>

* removed actions ssh key
forced-phot is now public and doesn't require authentication to clone 

* Updated source detail page layout (#526)

* Updated source detail page layout

- Added first detection JS9 at the top of the page.
- Extended the external results row count.
- Swap position of JS9 and aladin on measurement detail page to match.

* Minor tidy of new lines

- 

* fixed broken image detail link (#528)

* fixed broken image detail link
Fixes #527 

* updated changelog

* remove action git config to use ssh
With no private repo dependencies, we can use the default anonymous https instead.

* Bump lodash from 4.17.20 to 4.17.21 (#525)

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.20...4.17.21)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump hosted-git-info from 2.8.8 to 2.8.9 (#524)

Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9.
- [Release notes](https://github.com/npm/hosted-git-info/releases)
- [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md)
- [Commits](npm/hosted-git-info@v2.8.8...v2.8.9)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Versioning (#532)

* add versioning and updated release docs
Closes #492

* add version to run pipeline log
Closes #529

* updated migration docs
We should no longer instruct devs to squash migrations since the pipeline models are mostly stable and large runs exist

* exclude version file from docs

* added discussions and defines issues and PRs

* updated changelog


* simplify git flow description


* add version to page footer


* updated npm deps; removed bootstrap (#533)

* updated npm deps; removed bootstrap
Updated npm deps according to semver rules.
Removed bootstrap in favour of the version bundled with startbootstrap-sb-admin-2.

* updated changelog

* fixed breadcrumb truncation


* Update homepage text (#534)

* Update homepage text

- Reference to documentation.
- Removed reference to users not being able to run pipeline runs.
- Added version to homepage.

* Minor change to homepage text


* added help and acknowledgement doc page (#535)

* added help and acknowledgement doc page
Updated acknowledgements
Removed email link from docs footer
Closes #522

* docs: fix email links, removed slack from footer

* updated changelog


* changed source naming convention (#536)

* changed source naming convention
Replaced ASKAP_<coord> naming convention with J<coord>. Coords have an RA precision of 1 and a Dec precision of 0, matching the convention used in the VAST-P1 paper.
Sources can be searched by name with an optional "VAST" prefix which is silently removed before searching.
Includes a data migration to update existing source names.

* updated changelog
Closes #530

* remove redundant types from docstrings
Co-authored-by: Adam Stewart <[email protected]>

* fixed formatting of examples in docstrings

* define reverse data migration

* Removed survey source models, commands and references (#538)

* Removed survey source models, commands and references

- Removed `Survey`, `SurveySource` and `SurveySourceQuerySet` from models.
- Removed related fields from Source model and crossmatch relation.
- Removed `importsurvey` command and docs page.
- Updated schema diagrams.

Non related minor fixes:
- Updated command line docs page for `clearpiperun` command.
- Added type annotation to `remove_forced_meas()` in `forced_extraction.py`.

Fixes #462.

* Added merged migration file

* delete leftover refs to removed models

* added required fields to SourceSerializer

* Removed default_survey option from run config
- Also removed `SURVEYS_WORKING_DIR` from settings and env.
- Removed references from documentation.

Co-authored-by: Andrew O'Brien <[email protected]>

* prep for release v1.0.0

* updated release docs


Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Adam Stewart <[email protected]>
Co-authored-by: Shibli Saleheen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marxide marxide marxide approved these changes

Assignees

@ajstewart ajstewart

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ajstewart @marxide