[PATCH] D108374: [docs] Document how to install sphinx and recommonmark on Ubuntu
Yaron Keren via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Thu Aug 19 08:24:50 PDT 2021
This revision was not accepted when it landed; it landed in state "Needs Review".
This revision was automatically updated to reflect the committed changes.
Closed by commit rG1987eb9e9cc1: [docs] Document how to install sphinx and recommonmark on Ubuntu (authored by yaron.keren).
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D108374/new/
https://reviews.llvm.org/D108374
Files:
llvm/docs/SphinxQuickstartTemplate.rst
Index: llvm/docs/SphinxQuickstartTemplate.rst
===================================================================
--- llvm/docs/SphinxQuickstartTemplate.rst
+++ llvm/docs/SphinxQuickstartTemplate.rst
@@ -180,6 +180,12 @@
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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D108374.367509.patch
Type: text/x-patch
Size: 529 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210819/f89b84a2/attachment.bin>
More information about the llvm-commits
mailing list