Skip to content

Commit f9af8d9

Browse files
committed
Put the documentation requirements in a requirement files.
1 parent 9faad7e commit f9af8d9

File tree

4 files changed

+16
-21
lines changed

4 files changed

+16
-21
lines changed

.github/workflows/release-tasks.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,19 @@ jobs:
2424
release_version=$(echo "${{ github.ref_name }}" | sed 's/llvmorg-//g')
2525
echo "release-version=$release_version" >> $GITHUB_OUTPUT
2626
27+
- name: Checkout LLVM
28+
uses: actions/checkout@v3
29+
2730
- name: Install Dependencies
2831
run: |
2932
sudo apt-get update
3033
sudo apt-get install -y \
3134
doxygen \
3235
graphviz \
3336
python3-github \
34-
python3-myst-parser \
35-
python3-sphinx \
3637
ninja-build \
3738
texlive-font-utils
38-
pip3 install --user sphinx-markdown-tables
39-
40-
- name: Checkout LLVM
41-
uses: actions/checkout@v3
39+
pip3 install --user -r ./llvm/docs/requirements.txt
4240
4341
- name: Create Release
4442
run: |

llvm/docs/SphinxQuickstartTemplate.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -171,20 +171,12 @@ Generating the documentation
171171
You can generate the HTML documentation from the sources locally if you want to
172172
see what they would look like. In addition to the normal
173173
`build tools <docs/GettingStarted.html>`_
174-
you need to install `Sphinx`_ and the
175-
`myst-parser <https://myst-parser.readthedocs.io/en/latest/>`_ extension.
176-
177-
On Debian you can install these with:
178-
179-
.. code-block:: console
180-
181-
sudo apt install -y sphinx-doc python3-myst-parser
182-
183-
On Ubuntu use pip to get an up-to-date version of python3-myst-parser:
174+
you need to install `Sphinx`_ and the necessary extensions
175+
using the following command inside the ``llvm-project`` checkout:
184176

185177
.. code-block:: console
186178
187-
sudo pip install sphinx myst-parser
179+
pip install --user -r ./llvm/docs/requirements.txt
188180
189181
Then run cmake to build the documentation inside the ``llvm-project`` checkout:
190182

llvm/docs/requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sphinx
2+
myst-parser
3+
sphinx-markdown-tables
4+
sphinx-automodapi
5+
furo

llvm/utils/release/build-docs.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
#
1212
# Required Packages:
1313
# * Fedora:
14-
# * dnf install doxygen python3-sphinx texlive-epstopdf ghostscript \
14+
# * dnf install doxygen texlive-epstopdf ghostscript \
1515
# ninja-build gcc-c++
16-
# * pip install sphinx-markdown-tables
16+
# * pip install --user -r ./llvm/docs/requirements.txt
1717
# * Ubuntu:
18-
# * apt-get install doxygen sphinx-common python3-myst-parser \
18+
# * apt-get install doxygen \
1919
# ninja-build graphviz texlive-font-utils
20-
# * pip install sphinx-markdown-tables
20+
# * pip install --user -r ./llvm/docs/requirements.txt
2121
#===------------------------------------------------------------------------===#
2222

2323
set -ex

0 commit comments

Comments
 (0)