Put the documentation requirements in a requirement files.

Author: cor3ntin

.github/workflows/release-tasks.yml

@@ -24,21 +24,19 @@ jobs:
  release_version=$(echo "${{ github.ref_name }}" | sed 's/llvmorg-//g')
  echo "release-version=$release_version" >> $GITHUB_OUTPUT
 
+ - name: Checkout LLVM
+ uses: actions/checkout@v3
+
  - name: Install Dependencies
  run: |
  sudo apt-get update
  sudo apt-get install -y \
  doxygen \
  graphviz \
  python3-github \
- python3-myst-parser \
- python3-sphinx \
  ninja-build \
  texlive-font-utils
- pip3 install --user sphinx-markdown-tables
-
- - name: Checkout LLVM
- uses: actions/checkout@v3
+ pip3 install --user -r ./llvm/docs/requirements.txt
 
  - name: Create Release
  run: |

llvm/docs/SphinxQuickstartTemplate.rst

@@ -171,20 +171,12 @@ Generating the documentation
 You can generate the HTML documentation from the sources locally if you want to
 see what they would look like. In addition to the normal
 `build tools <docs/GettingStarted.html>`_
-you need to install `Sphinx`_ and the
-`myst-parser <https://myst-parser.readthedocs.io/en/latest/>`_ extension.
-
-On Debian you can install these with:
-
-.. code-block:: console
-
- sudo apt install -y sphinx-doc python3-myst-parser
-
-On Ubuntu use pip to get an up-to-date version of python3-myst-parser:
+you need to install `Sphinx`_ and the necessary extensions
+using the following command inside the ``llvm-project`` checkout:
 
 .. code-block:: console
 
- sudo pip install sphinx myst-parser
+ pip install --user -r ./llvm/docs/requirements.txt
 
 Then run cmake to build the documentation inside the ``llvm-project`` checkout:
 

llvm/docs/requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+myst-parser
+sphinx-markdown-tables
+sphinx-automodapi
+furo

llvm/utils/release/build-docs.sh

@@ -11,13 +11,13 @@
 #
 # Required Packages:
 # * Fedora:
-# * dnf install doxygen python3-sphinx texlive-epstopdf ghostscript \
+# * dnf install doxygen texlive-epstopdf ghostscript \
 # ninja-build gcc-c++
-# * pip install sphinx-markdown-tables
+# * pip install --user -r ./llvm/docs/requirements.txt
 # * Ubuntu:
-# * apt-get install doxygen sphinx-common python3-myst-parser \
+# * apt-get install doxygen \
 # ninja-build graphviz texlive-font-utils
-# * pip install sphinx-markdown-tables
+# * pip install --user -r ./llvm/docs/requirements.txt
 #===------------------------------------------------------------------------===#
 
 set -ex