X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7415e01eb23989648fb4850b5a0569796973445f..f004eb91960dddb9bf2ada5a7c1bd6852a61c2fe:/doc/README.textile diff --git a/doc/README.textile b/doc/README.textile index 9799ac564b..4c807a3dd6 100644 --- a/doc/README.textile +++ b/doc/README.textile @@ -25,7 +25,7 @@ arvados/doc$ python3 -m venv .venv arvados/doc$ .venv/bin/pip install pdoc -Then the generation process will need to be able to find @arvados/doc/.venv/bin/pdoc@. Either add that full directory to your @$PATH@, or make a @pdoc@ symlink in another directory that's already in your @$PATH@. +Then you must activate the virtualenv (e.g., run @. .venv/bin/activate@) before you run the @bundle exec rake@ commands below. h2. Generate HTML pages @@ -71,12 +71,6 @@ You can set @baseurl@ (the URL prefix for all internal links), @arvados_cluster_ arvados/doc$ bundle exec rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com -Make the docs appear at {workbench_host}/doc by creating a symbolic link in Workbench's @public@ directory, pointing to the generated HTML tree. - -
-arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
-
- h2. Delete generated files