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

[DOC] Update for mkdocs-material 9.5.19 and icons added to Install-LibreNMS.md #15989

Merged
merged 17 commits into from Apr 29, 2024

Conversation

santiag0z
Copy link
Contributor

@santiag0z santiag0z commented Apr 27, 2024

Please give a short description what your pull request is for

image

Reference:
https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/?h=icon

DO NOT DELETE THE UNDERLYING TEXT

Please note

Please read this information carefully. You can run ./lnms dev:check to check your code before submitting.

  • Have you followed our code guidelines?
  • If my Pull Request does some changes/fixes/enhancements in the WebUI, I have inserted a screenshot of it.
  • If my Pull Request makes discovery/polling/yaml changes, I have added/updated test data.

Testers

If you would like to test this pull request then please run: ./scripts/github-apply <pr_id>, i.e ./scripts/github-apply 5926
After you are done testing, you can remove the changes with ./scripts/github-remove. If there are schema changes, you can ask on discord how to revert.

murrant
murrant previously approved these changes Apr 27, 2024
@murrant
Copy link
Member

murrant commented Apr 27, 2024

You'll need to update the CI build (and documentation) to include the additional modules

@santiag0z
Copy link
Contributor Author

@murrant, I can't resolve the following error:

Error: MkDocs encountered an error parsing the configuration file: while constructing a Python object
cannot find module 'material.extensions.emoji' (No module named 'material.extensions')
in "/docs/mkdocs.yml", line 40, column 20
Error: Process completed with exit code 1.

.github/workflows/doc.yml Outdated Show resolved Hide resolved
@santiag0z
Copy link
Contributor Author

@murrant and @Jellyfrog

According to the pymdown-extensions documentation, pip install pymdown-extensions was supposed to be sufficient.

Looking at the problem below, sometimes you need pip install pymdown-extensions pip install mkdocs-material-extensions pip install mkdocs-material
facelessuser/pymdown-extensions#110

But I only had success after updating mkdocs-material version 8.3.9 -> 9.5.19

@santiag0z santiag0z changed the title [DOC] Install LibreNMS: add Icons [DOC] Update for mkdocs-material 9.5.19 and icons added to Install-LibreNMS.md Apr 28, 2024
Copy link
Member

@murrant murrant left a comment

Choose a reason for hiding this comment

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

Thanks for updating, looks good now. I didn't test build this locally, but should work.

@murrant murrant merged commit 20bd5a3 into librenms:master Apr 29, 2024
6 checks passed
@murrant
Copy link
Member

murrant commented Apr 29, 2024

@santiag0z
Copy link
Contributor Author

santiag0z commented Apr 29, 2024

putz! I was sad, I'm going to check it calmly and test it first by updating and then with the modification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants