From 922749d7340688e4bd42dc8120bf01ce3c3555c0 Mon Sep 17 00:00:00 2001 From: Vi P <129776839+vitropy@users.noreply.github.com> Date: Wed, 30 Aug 2023 06:37:19 -0400 Subject: [PATCH] Automatically redirect to the API docs entry page. (#10) --- .gitignore | 13 ++++++++++++- target/doc/index.html | 12 ++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 target/doc/index.html diff --git a/.gitignore b/.gitignore index 4103f0c..11704f0 100644 --- 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 new file mode 100644 index 0000000..b8654da --- /dev/null +++ b/target/doc/index.html @@ -0,0 +1,12 @@ + + + + + + + Redirecting…. + + +

Redirecting to this repository's API documentation….

+ +