docs: Use hamburger menu TOC for module pages on small screens #2606
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tmszi
added
enhancement
…addon instalation
…L dir for every addon instalation
To prevent the link path from being replaced with a local path during addon installation. Example: `<a href="#description">DESCRIPTION</a>` with `<a href="file:///usr/lib64/grass83/docs/html/#description">DESCRIPTION</a>`
|
How to test this PR: Core module HTML man page:
Addon HTML man page:
|
|
I tested it locally, the menu looks good (incl. submenus!):
|
Yes, you are right. I had these files copied manually. Thanks for the tip. Fixed with 6eb2856. |
|
... looks good to me! |
neteler
approved these changes
Oct 23, 2022
neteler
pushed a commit
that referenced
this pull request
Oct 23, 2022
… 1024 px (#2606) * utils: module HTML man page use hamburger menu TOC for screen width < 1024 px * Fix flake8, black errors. * g.extension: copy CSS style file into addons docs HTML dir for every addon instalation * g.extension: copy hamburger menu SVG image files into addons docs HTML dir for every addon instalation * utils: set CSS class for every hamburger menu link list item To prevent the link path from being replaced with a local path during addon installation. Example: `<a href="#description">DESCRIPTION</a>` with `<a href="file:///usr/lib64/grass83/docs/html/#description">DESCRIPTION</a>` * utils: fix space between HTML element attributes * man: install module HTML man page hamburger menu TOC SVG images
|
@tmszi: I just realize it now: the SVG also need to be installed in the https://grass.osgeo.org/grass82/manuals/addons/hamburger_menu.svg -> 404 |
When I tested it locally (addon installation), these two lines 15d5178 fixed this issue. |
|
@neteler We need add these two images here https://github.com/OSGeo/grass-addons/blob/grass8/utils/cronjobs_osgeo_lxd/cron_grass8_main_build_binaries.sh#L303. |
|
I found these pages doesn't have hamburger menu TOC: https://grass.osgeo.org/grass82/manuals/full_index.html https://grass.osgeo.org/grass82/manuals/keywords.html and needed standalone hamburger TOC menu implementation. |
ninsbl
pushed a commit
to ninsbl/grass
that referenced
this pull request
Feb 17, 2023
… 1024 px (OSGeo#2606) * utils: module HTML man page use hamburger menu TOC for screen width < 1024 px * Fix flake8, black errors. * g.extension: copy CSS style file into addons docs HTML dir for every addon instalation * g.extension: copy hamburger menu SVG image files into addons docs HTML dir for every addon instalation * utils: set CSS class for every hamburger menu link list item To prevent the link path from being replaced with a local path during addon installation. Example: `<a href="#description">DESCRIPTION</a>` with `<a href="file:///usr/lib64/grass83/docs/html/#description">DESCRIPTION</a>` * utils: fix space between HTML element attributes * man: install module HTML man page hamburger menu TOC SVG images
marisn
pushed a commit
to marisn/grass
that referenced
this pull request
Jun 2, 2023
… 1024 px (OSGeo#2606) * utils: module HTML man page use hamburger menu TOC for screen width < 1024 px * Fix flake8, black errors. * g.extension: copy CSS style file into addons docs HTML dir for every addon instalation * g.extension: copy hamburger menu SVG image files into addons docs HTML dir for every addon instalation * utils: set CSS class for every hamburger menu link list item To prevent the link path from being replaced with a local path during addon installation. Example: `<a href="#description">DESCRIPTION</a>` with `<a href="file:///usr/lib64/grass83/docs/html/#description">DESCRIPTION</a>` * utils: fix space between HTML element attributes * man: install module HTML man page hamburger menu TOC SVG images
wenzeslaus
changed the title
wenzeslaus
changed the title
wenzeslaus
changed the title
neteler
pushed a commit
to nilason/grass
that referenced
this pull request
Nov 7, 2023
… 1024 px (OSGeo#2606) * utils: module HTML man page use hamburger menu TOC for screen width < 1024 px * Fix flake8, black errors. * g.extension: copy CSS style file into addons docs HTML dir for every addon instalation * g.extension: copy hamburger menu SVG image files into addons docs HTML dir for every addon instalation * utils: set CSS class for every hamburger menu link list item To prevent the link path from being replaced with a local path during addon installation. Example: `<a href="#description">DESCRIPTION</a>` with `<a href="file:///usr/lib64/grass83/docs/html/#description">DESCRIPTION</a>` * utils: fix space between HTML element attributes * man: install module HTML man page hamburger menu TOC SVG images
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Module HTML man page use hamburger menu TOC #2589 (comment) for screen width < 1024 px.