summary refs log tree commit diff stats
path: root/compiler/index.nim
diff options
context:
space:
mode:
Diffstat (limited to 'compiler/index.nim')
-rw-r--r--compiler/index.nim18
1 files changed, 18 insertions, 0 deletions
diff --git a/compiler/index.nim b/compiler/index.nim
new file mode 100644
index 000000000..2c2a34fb5
--- /dev/null
+++ b/compiler/index.nim
@@ -0,0 +1,18 @@
+##[
+This module only exists to generate docs for the compiler.
+
+## links
+* [main docs](../lib.html)
+* [compiler user guide](../nimc.html)
+* [Internals of the Nim Compiler](../intern.html)
+]##
+
+#[
+note: this is named `index` so that navigating to https://nim-lang.github.io/Nim/compiler/
+will work.
+
+xxx this should also import other modules, not transitively imported by `compiler/nim.nim`,
+eg `evalffi`, otherwise these aren't shown. A glob could be used at CT.
+]#
+
+import nim