links to examples

outbrain · Sep 17, 2023 · d88b9c3 · d88b9c3
1 parent 7a69f64
commit d88b9c3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/DOCSMAIN.md b/docs/DOCSMAIN.md
@@ -30,6 +30,6 @@ outrank --help
 
 
 # Example use cases
-* A minimal showcase of performing feature ranking on a generic CSV is demonstrated with [this example](../scripts/run_minimal.sh)
+* A minimal showcase of performing feature ranking on a generic CSV is demonstrated with [this example](https://github.com/outbrain/outrank/tree/main/scripts)
 
-* [More examples](../scripts/) demonstrating OutRank's capabilities are also available.
+* [More examples](https://github.com/outbrain/outrank/tree/main/examples) demonstrating OutRank's capabilities are also available.
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
@@ -1,2 +1,4 @@
-# Note: this requires pdoc>=14.1.0 to run
-rm -rvf index.html outrank outrank.html search.js; cd ..; pdoc ./outrank -o docs;
+# Note: this requires pdoc>=14.1.0 to run (pip install pdoc>=14.1.0)
+rm -rvf index.html outrank outrank.html search.js;
+cd ..;
+pdoc ./outrank -o docs;