diff --git a/docs/css/neoteroi-mkdocs.css b/docs/css/neoteroi-mkdocs.css index ea6c1e0..8bba792 100644 --- a/docs/css/neoteroi-mkdocs.css +++ b/docs/css/neoteroi-mkdocs.css @@ -1,46 +1,56 @@ -.nt-cards { - &.nt-grid { - display: grid; - grid-auto-columns: 1fr; - gap: 0.5rem; - - // the following 3 rules are for mobile devices, to avoid - // the grid forcing the width of the page - max-width: 100vw; - overflow-x: auto; - padding: 1px; - - &.cols-1 { - grid-template-columns: repeat(1, 1fr); - } - - &.cols-2 { - grid-template-columns: repeat(2, 1fr); - } - - &.cols-3 { - grid-template-columns: repeat(3, 1fr); - } +.nt-cards.nt-grid { + display: grid; + grid-auto-columns: 1fr; + gap: 0.5rem; - &.cols-4 { - grid-template-columns: repeat(4, 1fr); - } + /* the following 3 rules are for mobile devices, to avoid */ + /* the grid forcing the width of the page */ + max-width: 100vw; + overflow-x: auto; + padding: 1px; +} - &.cols-5 { - grid-template-columns: repeat(5, 1fr); - } +@media only screen and (min-width: 701px) { + .nt-cards.nt-grid.cols-1 { + grid-template-columns: repeat(1, 1fr); + } + .nt-cards.nt-grid.cols-2 { + grid-template-columns: repeat(2, 1fr); + } + .nt-cards.nt-grid.cols-3 { + grid-template-columns: repeat(3, 1fr); + } + .nt-cards.nt-grid.cols-4 { + grid-template-columns: repeat(4, 1fr); + } + .nt-cards.nt-grid.cols-5 { + grid-template-columns: repeat(5, 1fr); + } + .nt-cards.nt-grid.cols-6 { + grid-template-columns: repeat(6, 1fr); + } +} - &.cols-6 { - grid-template-columns: repeat(6, 1fr); - } +@media only screen and (min-width: 501px) and (max-width: 700px) { + .nt-cards.nt-grid.cols-3 { + grid-template-columns: repeat(2, 1fr); + } + .nt-cards.nt-grid.cols-4 { + grid-template-columns: repeat(2, 1fr); + } + .nt-cards.nt-grid.cols-5 { + grid-template-columns: repeat(2, 1fr); + } + .nt-cards.nt-grid.cols-6 { + grid-template-columns: repeat(2, 1fr); } } -// for small devices +/* for small devices */ @media only screen and (max-width: 400px) { - // force one card per line + /* force one card per line */ .nt-cards.nt-grid { grid-template-columns: repeat(1, 1fr) !important; } diff --git a/docs/getting-started/csm-stack/image-to-ground-tutorial.ipynb b/docs/getting-started/csm-stack/image-to-ground-tutorial.ipynb index 7dba7c6..ea3f766 100644 --- a/docs/getting-started/csm-stack/image-to-ground-tutorial.ipynb +++ b/docs/getting-started/csm-stack/image-to-ground-tutorial.ipynb @@ -45,19 +45,10 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": null, "id": "7f58cb34-d27f-456d-bfb5-f9075ca575b3", "metadata": {}, - "outputs": [ - { - "name": "stderr", - "output_type": "stream", - "text": [ - "/Users/chkim/mambaforge3/envs/test/lib/python3.12/site-packages/osgeo/gdal.py:287: FutureWarning: Neither gdal.UseExceptions() nor gdal.DontUseExceptions() has been explicitly called. In GDAL 4.0, exceptions will be enabled by default.\n", - " warnings.warn(\n" - ] - } - ], + "outputs": [], "source": [ "import ale\n", "import json\n", diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index ab463e5..5f951e8 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -45,9 +45,13 @@ When creating a new getting-started tutorial, first you need to make sure what y Concrete things your tutorial needs: -- [ ] If your tutorial requires installing software, list what software and their versions and clear instructions on how to install them. Feel free to point to other points of the doc that already have boilerplate info like "Go here to read on how to set up a custom ISISPreferences file". -- [ ] If your tutorial has data, use generative data or data that is in the repo. Avoid external data dependencies. Before data is committed into the repo, check if [existing data can be re-used](./data/). If new data needs to be committed, make sure it is small so as not to increase the data burden. -- [ ] Make sure to make the lesson clear in the title. Also, make it clear in the tutorial with something like "Lessons learned in this tutorial:". - +- [ ] If your tutorial requires software, list the software with versions and installation instructions. Feel free to link to existing docs with boilerplate info, for example: + ``` + See [User Preferences File](../concepts/isis-fundamentals/preference-dictionary.md#user-preference-file) + or [Project Preference File](../concepts/isis-fundamentals/preference-dictionary.md#project-preference-file) + for more info on custom ISISPreferences files. + ``` +- [ ] If your tutorial has data, use generative data or data that is in the repo. Avoid external data dependencies. Before data is committed into the repo, check if [existing data can be re-used](https://github.com/DOI-USGS/asc-public-docs/tree/main/docs/assets). If new data needs to be committed, minimize the size so as not to increase the data burden. +- [ ] Make the objectives clear in the title. Also, clarify the tutorial with a summary of objectives. See the [git repo](https://code.usgs.gov/astrogeology/asc-public-docs) for more in-depth info on how to contribute new docs. diff --git a/docs/manuals/index.md b/docs/manuals/index.md index ac8e394..81b6fbd 100644 --- a/docs/manuals/index.md +++ b/docs/manuals/index.md @@ -7,33 +7,26 @@ hide: # Software Manuals -::cards:: cols=3 image-bg +::cards:: cols=4 image-bg -[ - { - "title": "ISIS", - "content": "Integrated Software for Imagers and Spectrometers", - "url" : https://isis.astrogeology.usgs.gov/, - "image" : "https://raw.githubusercontent.com/DOI-USGS/ISIS3/dev/rtd_docs/ISIS_Logo.svg" - }, - { - "title": "USGSCSM", - "content": "USGS Community Sensor Models", - "url" : ./usgscsm/, - "image" : "https://raw.githubusercontent.com/DOI-USGS/usgscsm/main/docs/USGSCSM_Logo.svg" - }, - { - "title": "ALE", - "content": "Abstraction Library for Ephemerides", - "url" : ./ale/, - "image" : "https://raw.githubusercontent.com/DOI-USGS/ale/main/docs/ALE_Logo.svg" - }, - { - "title": "PLIO", - "content": "Planetary Input/Output Library", - "url" : ./plio/, - "image" : https://raw.githubusercontent.com/DOI-USGS/plio/main/docs/PLIO_Logo.svg - }, -] +- title: ISIS + content: Integrated Software for Imagers and Spectrometers + url: https://isis.astrogeology.usgs.gov/ + image: https://raw.githubusercontent.com/DOI-USGS/ISIS3/dev/rtd_docs/ISIS_Logo.svg + +- title: USGSCSM + content: USGS Community Sensor Models + url: ./usgscsm/ + image: https://raw.githubusercontent.com/DOI-USGS/usgscsm/main/docs/USGSCSM_Logo.svg + +- title: ALE + content: Abstraction Library for Ephemerides + url: ./ale/ + image: https://raw.githubusercontent.com/DOI-USGS/ale/main/docs/ALE_Logo.svg + +- title: PLIO + content: Planetary Input/Output Library + url: ./plio/ + image: https://raw.githubusercontent.com/DOI-USGS/plio/main/docs/PLIO_Logo.svg ::/cards:: diff --git a/mkdocs.yml b/mkdocs.yml index 303c3e2..0ffffac 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -159,8 +159,8 @@ markdown_extensions: class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.snippets: auto_append: - definitions.md