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

Improvements for downstream-distro maintainability. #4730

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

KrystalDelusion
Copy link
Member

@KrystalDelusion KrystalDelusion commented Nov 12, 2024

What are the reasons/motivation for this change?
#4725

Explain how this is achieved.

  • Make furo-ys an optional dependency
  • Change .svg badges to html-only
  • Add envvar check for non-readthedocs, non-preview build YOSYS_DOCS_RELEASE

If applicable, please suggest to reviewers how they can test the change.
Call e.g. YOSYS_DOCS_RELEASE= make docs from the top directory and check there are no todos in the output.

This is mainly intended for (latex)pdf builds which do not use the furo-ys html theme, where the yosys script syntax highlighting can safely fallback to plaintext.  This effectively makes `furo-ys` an optional dependency to simplify distro-package maintainability.
See also #4725.
@KrystalDelusion KrystalDelusion linked an issue Nov 12, 2024 that may be closed by this pull request
@KrystalDelusion KrystalDelusion marked this pull request as ready for review November 19, 2024 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

yosys docs vs. downstream distro-package maintainability
1 participant