From ba8101bf91e0502227d08f0148c6d004d915b504 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Wed, 21 Feb 2024 11:04:15 -0500 Subject: [PATCH] 21494: Document build requirements for all SDK documentation Arvados-DCO-1.1-Signed-off-by: Brett Smith --- doc/README.textile | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/README.textile b/doc/README.textile index 59dca48dd6..b30540b105 100644 --- a/doc/README.textile +++ b/doc/README.textile @@ -12,12 +12,22 @@ Additional information is available on the "'Documentation' page on the Arvados h2. Install dependencies +To build the core Arvados documentation: +
 arvados/doc$ sudo apt-get install build-essential libcurl4-openssl-dev libgnutls28-dev libssl-dev
 arvados/doc$ bundle install
 
-To generate the Python SDK documentation, these additional dependencies are needed: +SDK reference documentation has additional, optional build requirements. + +h3. Java SDK documentation + +
+$ sudo apt install gradle
+
+ +h3. Python SDK documentation
 arvados/doc$ sudo apt install python3-venv
@@ -27,6 +37,12 @@ arvados/doc$ .venv/bin/pip install pdoc setuptools
 
 Then you must activate the virtualenv (e.g., run @. .venv/bin/activate@) before you run the @bundle exec rake@ commands below.
 
+h3. R SDK documentation
+
+
+$ sudo apt install r-cran-devtools r-cran-roxygen2 r-cran-knitr r-cran-markdown r-cran-xml
+
+ h2. Generate HTML pages
-- 
2.30.2