[llvm] 1987eb9 - [docs] Document how to install sphinx and recommonmark on Ubuntu

Yaron Keren via llvm-commits llvm-commits at lists.llvm.org
Thu Aug 19 08:24:37 PDT 2021


Author: Yaron Keren
Date: 2021-08-19T18:24:17+03:00
New Revision: 1987eb9e9cc1584e38bde94fe55e59985f57e170

URL: https://github.com/llvm/llvm-project/commit/1987eb9e9cc1584e38bde94fe55e59985f57e170
DIFF: https://github.com/llvm/llvm-project/commit/1987eb9e9cc1584e38bde94fe55e59985f57e170.diff

LOG: [docs] Document how to install sphinx and recommonmark on Ubuntu

Differential Revision: https://reviews.llvm.org/D108374

Added: 
    

Modified: 
    llvm/docs/SphinxQuickstartTemplate.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/SphinxQuickstartTemplate.rst b/llvm/docs/SphinxQuickstartTemplate.rst
index dcf21645a84e..f15970dec30c 100644
--- a/llvm/docs/SphinxQuickstartTemplate.rst
+++ b/llvm/docs/SphinxQuickstartTemplate.rst
@@ -180,6 +180,12 @@ On Debian you can install these with:
 
    sudo apt install -y sphinx-doc python-recommonmark-doc
 
+On Ubuntu use pip to get an up-to-date version of recommonmark:
+
+.. code-block:: console
+
+   sudo pip install sphinx recommonmark
+
 Then run cmake to build the documentation inside the ``llvm-project`` checkout:
 
 .. code-block:: console


        


More information about the llvm-commits mailing list