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

Improve build from source section #402

Merged
merged 6 commits into from
Oct 28, 2024
Merged

Conversation

melroy89
Copy link
Contributor

  • Add Sphinx-Substitution-Extensions to pypi requirements: https://pypi.org/project/sphinx-substitution-extensions/
  • Use Sphinix extension for code blocks: sphinx_substitution_extensions
  • Rename Ubuntu 20.04 LTS to just Ubuntu
  • Use substitution for the version number in both the text as well as the code block

Should we also try to upgrade Sphinx to v8.1.3 next?

@k0ekk0ek
Copy link
Contributor

Thanks @melroy89!

@k0ekk0ek k0ekk0ek merged commit daef4cc into NLnetLabs:master Oct 28, 2024
4 checks passed
@melroy89
Copy link
Contributor Author

Oei I notice something doesn't work. Somehow with the substitution of the version number in the code block.

@k0ekk0ek But I did do it correcty right? Is the pip package installed om the server correctly? What did I miss?
Screenshot_20241028-153516

@melroy89 melroy89 deleted the patch-3 branch October 28, 2024 14:37
@k0ekk0ek
Copy link
Contributor

Oh, now I recall... I made these types of changes myself and then found out |version| is not supported in code blocks.

@k0ekk0ek
Copy link
Contributor

@melroy89, do you want me to issue a PR or do you prefer to send a follow-up PR to fix it (either is fine with me).

@melroy89
Copy link
Contributor Author

Oh, now I recall... I made these types of changes myself and then found out |version| is not supported in code blocks.

Yes it is supported with this python extension. That is the whole point of introducing https://pypi.org/project/sphinx-substitution-extensions/

@k0ekk0ek
Copy link
Contributor

Well, the extension page says Sphinx 7.2.0+. As we've pinned on 5.0.2, that is presumably the problem(?)

@melroy89
Copy link
Contributor Author

Well, the extension page says Sphinx 7.2.0+. As we've pinned on 5.0.2, that is presumably the problem(?)

Can we upgrade Sphinx for NSD?

@melroy89
Copy link
Contributor Author

aha you did! 89aeb68 let's hope it works!?

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.

2 participants