X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7a98271d94163cdc4afa5bfcf275db353bc062d2..ae4eb84a350994daee72a21f380ea04bb2ca9f63:/doc/README.textile diff --git a/doc/README.textile b/doc/README.textile index 9d58dfeb63..75a30e9ef2 100644 --- a/doc/README.textile +++ b/doc/README.textile @@ -1,15 +1,20 @@ +###. Copyright (C) The Arvados Authors. All rights reserved. +.... +.... SPDX-License-Identifier: CC-BY-SA-3.0 + h1. Arvados documentation This is the source code for "doc.arvados.org":http://doc.arvados.org. Here's how to build the HTML pages locally so you can preview your updates before you commit and push. -Additional information is available on the "'Documentation' page on the Arvados wiki":https://arvados.org/projects/arvados/wiki/Documentation. +Additional information is available on the "'Documentation' page on the Arvados wiki":https://dev.arvados.org/projects/arvados/wiki/Documentation. h2. Install dependencies
 arvados/doc$ bundle install
+arvados/doc$ pip install epydoc
 
h2. Generate HTML pages @@ -50,7 +55,7 @@ h2. Publish HTML pages inside Workbench (or some other web site) -You can set @baseurl@ (the URL prefix for all internal links), @arvados_api_host@ and @arvados_workbench_host@ without changing @_config.yml@: +You can set @baseurl@ (the URL prefix for all internal links), @arvados_cluster_uuid@, @arvados_api_host@ and @arvados_workbench_host@ without changing @_config.yml@:
 arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com