X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/4f552c0187f8c31d94ff74485c57ef7f9888597e..8e657ade7a2c4881756064c5810d9946f61f5353:/doc/README.textile?ds=sidebyside diff --git a/doc/README.textile b/doc/README.textile index 9d58dfeb63..85757980a7 100644 --- a/doc/README.textile +++ b/doc/README.textile @@ -1,27 +1,40 @@ +###. 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$ 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: + +
+arvados/doc$ sudo apt-get install python3-pip +arvados/doc$ pip3 install arvados-python-client +arvados/doc$ pip3 install pdoc3 ++ h2. Generate HTML pages
-arvados/doc$ rake +arvados/doc$ bundle exec rakeAlternately, to make the documentation browsable on the local filesystem:
-arvados/doc$ rake generate baseurl=$PWD/.site +arvados/doc$ bundle exec rake generate baseurl=$PWD/.siteh2. Run linkchecker @@ -30,7 +43,7 @@ If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on your system, you can run it against the documentation:
-arvados/doc$ rake linkchecker baseurl=file://$PWD/.site +arvados/doc$ bundle exec rake linkchecker baseurl=file://$PWD/.sitePlease note that this will regenerate your $PWD/.site directory. @@ -38,7 +51,7 @@ Please note that this will regenerate your $PWD/.site directory. h2. Preview HTML pages
-arvados/doc$ rake run +arvados/doc$ bundle exec rake run [2014-03-10 09:03:41] INFO WEBrick 1.3.1 [2014-03-10 09:03:41] INFO ruby 2.1.1 (2014-02-24) [x86_64-linux] [2014-03-10 09:03:41] INFO WEBrick::HTTPServer#start: pid=8926 port=8000 @@ -50,10 +63,10 @@ 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 +arvados/doc$ bundle exec rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.comMake the docs appear at {workbench_host}/doc by creating a symbolic link in Workbench's @public@ directory, pointing to the generated HTML tree. @@ -65,5 +78,5 @@ arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc h2. Delete generated files-arvados/doc$ rake realclean +arvados/doc$ bundle exec rake realclean