Automatically redirect to the API docs entry page. (#10)

entropyxyz · Aug 30, 2023 · 922749d · 922749d
1 parent 71f67de
commit 922749d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,14 @@
-/target
+# The `target` directory is generated by Cargo.
+# It will contain mostly compiled files and executables.
+target/*
+
+# But the API documentation eventually gets published, so we want to
+# make sure these files are also included in commits for downstream
+# services to consume, and these are by default output to `target/doc`.
+!target/doc
+target/doc/*
+!target/doc/index.html
+
+# Other ignores go here.
 node_modules
 /Cargo.lock
diff --git a/target/doc/index.html b/target/doc/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv="refresh" content="0; url=x25519_chacha20poly1305/" />
+    <title>Redirecting&hellip;.</title>
+</head>
+<body>
+    <p>Redirecting to this repository's <a href="x25519_chacha20poly1305/">API documentation</a>&hellip;.</p>
+</body>
+</html>