11308: Merge branch 'master' into 11308-python3

[arvados.git] / doc / README.textile

diff --git a/doc/README.textile b/doc/README.textile
index de97e5d3bdf52584f4aaf8e28d899a8a6137d4c5..b860df5f5e87eb86e2a33002984fe0dcee5ab397 100644 (file)
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -2,45 +2,69 @@ 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.
+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. 0. Install dependencies
+h2. Install dependencies
 
- arvados/doc$ bundle install
+<pre>
+arvados/doc$ bundle install
+arvados/doc$ pip install epydoc
+</pre>
 
-h2. 1. Generate HTML pages
+h2. Generate HTML pages
 
- arvados/doc$ rake
+<pre>
+arvados/doc$ rake
+</pre>
 
-h2. 2. Preview HTML pages
+Alternately, to make the documentation browsable on the local filesystem:
 
- arvados/doc$ rake run
+<pre>
+arvados/doc$ rake generate baseurl=$PWD/.site
+</pre>
+
+h2. Run linkchecker
+
+If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on
+your system, you can run it against the documentation:
+
+<pre>
+arvados/doc$ rake linkchecker baseurl=file://$PWD/.site
+</pre>
+
+Please note that this will regenerate your $PWD/.site directory.
+
+h2. Preview HTML pages
+
+<pre>
+arvados/doc$ 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
+</pre>
 
 Preview the rendered pages at "http://localhost:8000":http://localhost:8000.
 
-h2. 3. Publish HTML pages inside Workbench
+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_api_host@ and @arvados_workbench_host@ without changing @_config.yml@:
 
- arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+<pre>
+arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+</pre>
 
-Make the docs appear at {workbench_host}/doc by creating a symbolic
-link in Workbench's @public@ directory, pointing to the generated HTML
-tree.
+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
+<pre>
+arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
+</pre>
 
-h2. 4. Delete generated files
+h2. Delete generated files
 
- arvados/doc$ rake realclean
+<pre>
+arvados/doc$ rake realclean
+</pre>