cve-bin-tool icon indicating copy to clipboard operation
cve-bin-tool copied to clipboard

docs: upgrading sphinx & myst-parser

Open terriko opened this issue 1 year ago • 1 comments

  • See https://github.com/intel/cve-bin-tool/pull/4306

Looks like the automatic version bump for sphinx failed because myst-parser doesn't support sphinx 8+. I'm happy to just wait until it does, but I"m opening this up in case anyone else wants to do some investigation and figure out what it would take to upgrade.

terriko avatar Aug 05 '24 18:08 terriko

Looks like myst-parser has indeed updated. If someone's interested, this should be a beginner friendly issue now:

  • update Sphinx to latest (at least 8.0.2)
  • update myst-parser to latest (at least 4.0.0)
  • go into the docs directory and build the docs using the makefile
  • look at the generated output and make sure looks correct -- In particular, make sure any tables have formatted correctly and that the table of contents actually works.
  • If all is well, edit doc/requirements.txt to use the latest versions and make a pull request to update those two components

terriko avatar Aug 13 '24 21:08 terriko

Taking over this issue to work on it. First ever contribution that I make to the open source world, excited to delve into it. Please let me know if you need anything else from me while I am working on it, many thanks.

giacob500 avatar Nov 11 '24 18:11 giacob500

@giacob500 thanks for taking this one on!

terriko avatar Nov 12 '24 19:11 terriko

hi @terriko is this issue still open?

Gyan-max avatar Feb 06 '25 16:02 Gyan-max

No, this should have been closed by #4581. I'll close it now.

terriko avatar Feb 06 '25 22:02 terriko