aboutsummaryrefslogtreecommitdiff
path: root/doc/stdlib
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2019-02-25 09:27:58 +0100
committerEmilio Jesus Gallego Arias2019-02-26 21:49:13 +0100
commit07ce2588740f689fe92a8d00dd1aeccda5255130 (patch)
tree234671fa7f181f9d4f8205a6de1da3ca3c35e83a /doc/stdlib
parent9d6f268723b6352a97bcc3baf0df57f1c1b251fa (diff)
[dune] Simple rule to generate Stdlib's documentation.
Ideally this will be handled by Dune's native library support, but this could be useful for the likes of #9648. I am not sure what should be done w.r.t. style files.
Diffstat (limited to 'doc/stdlib')
-rw-r--r--doc/stdlib/dune36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/stdlib/dune b/doc/stdlib/dune
new file mode 100644
index 0000000000..7fe2493fbf
--- /dev/null
+++ b/doc/stdlib/dune
@@ -0,0 +1,36 @@
+; This is an ad-hoc rule to ease the migration, it should be handled
+; natively by Dune in the future.
+(rule
+ (targets index-list.html)
+ (deps
+ make-library-index index-list.html.template hidden-files
+ (source_tree %{project_root}/theories)
+ (source_tree %{project_root}/plugins))
+ (action
+ (chdir %{project_root}
+ ; On windows run will fail
+ (bash "doc/stdlib/make-library-index doc/stdlib/index-list.html doc/stdlib/hidden-files"))))
+
+(rule
+ (targets html)
+ (deps
+ ; This will be replaced soon by `theories/**/*.v` soon, thanks to rgrinberg
+ (source_tree %{project_root}/theories)
+ (source_tree %{project_root}/plugins)
+ (:header %{project_root}/doc/common/styles/html/coqremote/header.html)
+ (:footer %{project_root}/doc/common/styles/html/coqremote/footer.html)
+ ; For .glob files, should be gone when Coq Dune is smarter.
+ (package coq))
+ (action
+ (progn
+ (run mkdir -p html)
+ (bash "%{bin:coqdoc} -q -d html --with-header %{header} --with-footer %{footer} --multi-index --html -g -R %{project_root}/theories Coq -R %{project_root}/plugins Coq $(find %{project_root}/theories %{project_root}/plugins -name *.v)")
+ (run mv html/index.html html/genindex.html)
+ (with-stdout-to
+ _index.html
+ (progn (cat %{header}) (cat index-list.html) (cat %{footer})))
+ (run cp _index.html html/index.html))))
+
+(alias
+ (name stdlib-html)
+ (deps html))