llvm-docs require at least myst-parser and markdown-it-py

[ken@…]

I tried to build the docs for llvm-18.1.7 since until now I've had sufficient deps. Failed:

Doing llvm html
...
Extension error:
Could not import extension myst_parser (exception: No module named 'myst_parser')
ninja: build stopped: subcommand failed.

The home page for myst_parser implies it has runtime dependencies. At this point I lost interest in trying to build the docs.

Possibly recommonmark is no-longer needed (but for all I know clang or the man pages might still need that. }}}

[Bruce Dubbs]

This works for me.

$ sudo pip3 install myst_parser
Collecting myst_parser
  Downloading myst_parser-3.0.1-py3-none-any.whl.metadata (5.5 kB)
Requirement already satisfied: docutils<0.22,>=0.18 in /usr/lib/python3.12/site-packages (from myst_parser) (0.21.2)
Requirement already satisfied: jinja2 in /usr/lib/python3.12/site-packages (from myst_parser) (3.1.4)
Collecting markdown-it-py~=3.0 (from myst_parser)
  Downloading markdown_it_py-3.0.0-py3-none-any.whl.metadata (6.9 kB)
Collecting mdit-py-plugins~=0.4 (from myst_parser)
  Downloading mdit_py_plugins-0.4.1-py3-none-any.whl.metadata (2.8 kB)
Requirement already satisfied: pyyaml in /usr/lib/python3.12/site-packages (from myst_parser) (6.0.1)
Requirement already satisfied: sphinx<8,>=6 in /usr/lib/python3.12/site-packages (from myst_parser) (7.3.7)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst_parser)
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Requirement already satisfied: sphinxcontrib-applehelp in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.0.8)
Requirement already satisfied: sphinxcontrib-devhelp in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.0.2)
Requirement already satisfied: sphinxcontrib-jsmath in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.0.1)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (2.0.1)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.1.9)
Requirement already satisfied: sphinxcontrib-qthelp in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.0.3)
Requirement already satisfied: Pygments>=2.14 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (2.18.0)
Requirement already satisfied: snowballstemmer>=2.0 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (2.2.0)
Requirement already satisfied: babel>=2.9 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (2.11.0)
Requirement already satisfied: alabaster~=0.7.14 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (0.7.16)
Requirement already satisfied: imagesize>=1.3 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (1.4.1)
Requirement already satisfied: requests>=2.25.0 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (2.32.3)
Requirement already satisfied: packaging>=21.0 in /usr/lib/python3.12/site-packages (from sphinx<8,>=6->myst_parser) (24.1)
Requirement already satisfied: MarkupSafe>=2.0 in /usr/lib/python3.12/site-packages (from jinja2->myst_parser) (2.1.5)
Requirement already satisfied: pytz>=2015.7 in /usr/lib/python3.12/site-packages (from babel>=2.9->sphinx<8,>=6->myst_parser) (2024.1)
Requirement already satisfied: charset-normalizer<4,>=2 in /usr/lib/python3.12/site-packages (from requests>=2.25.0->sphinx<8,>=6->myst_parser) (3.0.1)
Requirement already satisfied: idna<4,>=2.5 in /usr/lib/python3.12/site-packages (from requests>=2.25.0->sphinx<8,>=6->myst_parser) (3.4)
Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/lib/python3.12/site-packages (from requests>=2.25.0->sphinx<8,>=6->myst_parser) (2.0.2)
Downloading myst_parser-3.0.1-py3-none-any.whl (83 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.2/83.2 kB 2.0 MB/s eta 0:00:00
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 87.5/87.5 kB 9.4 MB/s eta 0:00:00
Downloading mdit_py_plugins-0.4.1-py3-none-any.whl (54 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 54.8/54.8 kB 7.9 MB/s eta 0:00:00
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Installing collected packages: mdurl, markdown-it-py, mdit-py-plugins, myst_parser
Successfully installed markdown-it-py-3.0.0 mdit-py-plugins-0.4.1 mdurl-0.1.2 myst_parser-3.0.1

Then:

$ ninja docs-llvm-html  docs-llvm-man
[0/2] Generating man Sphinx documentation for l...to "/build/llvm/llvm-18.1.7.src/build/docs/man"
[1/2] Generating man Sphinx documentation for l...to "/build/llvm/llvm-18.1.7.src/build/docs/man"
WARNING: cannot cache unpickable configuration value: 'myst_heading_slug_func' (because it contains a function, class, or module object)
[2/2] Generating html Sphinx documentation for ...o "/build/llvm/llvm-18.1.7.src/build/docs/html"
WARNING: cannot cache unpickable configuration value: 'myst_heading_slug_func' (because it contains a function, class, or module object)

[Xi Ruoyao]

I'd just comment out the doc instruction and list mdurl, markdown-it-py, mdit-py-plugins, and myst_parser as external dependencies if no objection.

[Bruce Dubbs]

Replying to Xi Ruoyao:

I'd just comment out the doc instruction and list mdurl, markdown-it-py, mdit-py-plugins, and myst_parser as external dependencies if no objection.

I have no objection. Adding 4 packages, even though they are simple, is more work than it is worth.

[Xi Ruoyao]

Dependency updated and command commented out at r12.1-1025-g21cc0cffa2.

Closing as wontfix instead of fixed because we still don't have the doc.