add doc, rename server.ml to osh.ml

43b51c24 · zapashcanon · 204f042f · 43b51c24 · 43b51c24 · 43b51c24
Unverified Commit 43b51c24 authored Oct 07, 2021 by zapashcanon
Hide whitespace changes
Inline Side-by-side

Showing with 23 additions and 2 deletions

doc/dune doc/dune +3 -0

doc/index.mld doc/index.mld +18 -0

src/dune src/dune +2 -2

src/osh.ml src/osh.ml +0 -0

No files found.
--- a/doc/dune
+++ b/doc/dune
+(documentation
+ (package osh)
+ (mld_files index))
--- a/doc/index.mld
+++ b/doc/index.mld
+{0 osh}
+
+{{:https://osh.ocamlpro.com} osh} is an {{:https://ocaml.org} OCaml} website providing an API to generate SVG badges.
+
+{1:webapi Web API}
+
+See the documentation on the {{:https://osh.ocamlpro.com} online instance}.
+
+
+{1:modules Modules}
+
+You shouldn't have to use any of these modules, they're used internally only.
+
+{!modules:
+Osh.Content
+Osh.Server
+Osh.Template
+}
--- a/src/dune
+++ b/src/dune
 (executable
- (name server)
- (modules content server template)
+ (public_name osh)
+ (modules content osh template)
 (libraries dream ezcurl ocb omd yojson))

 (rule

--- a/src/server.ml
+++ b/src/server.ml