docs: upgrading sphinx & myst-parser

intel / cve-bin-tool

The CVE Binary Tool helps you determine if your system includes known vulnerabilities. You can scan binaries for over 200 common, vulnerable components (openssl, libpng, libxml2, expat and others), or if you know the components used, you can get a list of known vulnerabilities associated with an SBOM or a list of components and versions.

https://cve-bin-tool.readthedocs.io/en/latest/

GNU General Public License v3.0

1.24k stars 464 forks source link

docs: upgrading sphinx & myst-parser #4311

Open terriko opened 3 months ago

terriko commented 3 months ago

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 commented 3 months ago

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

giacob500 commented 1 week ago

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.

terriko commented 1 week ago

@giacob500 thanks for taking this one on!