Skip to content

Commit

Permalink
Title for API docs (#34)
Browse files Browse the repository at this point in the history 
* Title for API docs

* stack exec hell scripts/gen-docs.hell
  • Loading branch information
@chrisdone
chrisdone committed Sep 3, 2024
1 parent 0561cb0 commit 77d9c38
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE HTML><html><style>body {max-width: 40em; margin: .5in auto;} h1,h2,h3,h4,h5,h6 {font-family: Helvetica;} a {color: #1a6e8e}</style><body><h1>Hell&#39;s API</h1><p><a href="../">Back to homepage</a></p><h2>Types</h2><ul><li><code><em>data </em><strong>Bool</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>ByteString</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Char</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>ConsL</strong><em> :: </em>Symbol -&gt; * -&gt; List -&gt; List</code></li><li><code><em>data </em><strong>Double</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Either</strong><em> :: </em>* -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>ExitCode</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>IO</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>Int</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Map</strong><em> :: </em>* -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Maybe</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>NilL</strong><em> :: </em>List</code></li><li><code><em>data </em><strong>ProcessConfig</strong><em> :: </em>* -&gt; * -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Record</strong><em> :: </em>List -&gt; *</code></li><li><code><em>data </em><strong>Set</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>Tagged</strong><em> :: </em>Symbol -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Text</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Value</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Vector</strong><em> :: </em>* -&gt; *</code></li></ul><h2>Terms</h2><ul><li><code><strong>$</strong><em> :: </em>forall a_0 b_1 . (a_0 -&gt; b_1) -&gt; a_0 -&gt; b_1</code></li></ul><ul><li><code><strong>.</strong><em> :: </em>forall a_0 b_1 c_2 . (b_1 -&gt; c_2) -&gt; (a_0 -&gt; b_1) -&gt; a_0 -&gt; c_2</code></li></ul><ul><li><code><strong>Async.concurrently</strong><em> :: </em>forall a_0 b_1 .
<!DOCTYPE HTML><html><style>body {max-width: 40em; margin: .5in auto;} h1,h2,h3,h4,h5,h6 {font-family: Helvetica;} a {color: #1a6e8e}</style><head><title>Hell&#39;s API</title></head><body><h1>Hell&#39;s API</h1><p><a href="../">Back to homepage</a></p><h2>Types</h2><ul><li><code><em>data </em><strong>Bool</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>ByteString</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Char</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>ConsL</strong><em> :: </em>Symbol -&gt; * -&gt; List -&gt; List</code></li><li><code><em>data </em><strong>Double</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Either</strong><em> :: </em>* -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>ExitCode</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>IO</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>Int</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Map</strong><em> :: </em>* -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Maybe</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>NilL</strong><em> :: </em>List</code></li><li><code><em>data </em><strong>ProcessConfig</strong><em> :: </em>* -&gt; * -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Record</strong><em> :: </em>List -&gt; *</code></li><li><code><em>data </em><strong>Set</strong><em> :: </em>* -&gt; *</code></li><li><code><em>data </em><strong>Tagged</strong><em> :: </em>Symbol -&gt; * -&gt; *</code></li><li><code><em>data </em><strong>Text</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Value</strong><em> :: </em>*</code></li><li><code><em>data </em><strong>Vector</strong><em> :: </em>* -&gt; *</code></li></ul><h2>Terms</h2><ul><li><code><strong>$</strong><em> :: </em>forall a_0 b_1 . (a_0 -&gt; b_1) -&gt; a_0 -&gt; b_1</code></li></ul><ul><li><code><strong>.</strong><em> :: </em>forall a_0 b_1 c_2 . (b_1 -&gt; c_2) -&gt; (a_0 -&gt; b_1) -&gt; a_0 -&gt; c_2</code></li></ul><ul><li><code><strong>Async.concurrently</strong><em> :: </em>forall a_0 b_1 .
GHC.Types.IO a_0 -&gt; GHC.Types.IO b_1 -&gt; GHC.Types.IO (a_0, b_1)</code></li><li><code><strong>Async.pooledForConcurrently</strong><em> :: </em>forall a_0 b_1 .
[a_0] -&gt; (a_0 -&gt; GHC.Types.IO b_1) -&gt; GHC.Types.IO ([b_1])</code></li><li><code><strong>Async.pooledForConcurrently_</strong><em> :: </em>forall a_0 . [a_0] -&gt; (a_0 -&gt; GHC.Types.IO ()) -&gt; GHC.Types.IO ()</code></li><li><code><strong>Async.pooledMapConcurrently</strong><em> :: </em>forall a_0 b_1 .
(a_0 -&gt; GHC.Types.IO b_1) -&gt; [a_0] -&gt; GHC.Types.IO ([b_1])</code></li><li><code><strong>Async.pooledMapConcurrently_</strong><em> :: </em>forall a_0 . (a_0 -&gt; GHC.Types.IO ()) -&gt; [a_0] -&gt; GHC.Types.IO ()</code></li><li><code><strong>Async.race</strong><em> :: </em>forall a_0 b_1 .
Expand Down
2 changes: 2 additions & 0 deletions src/Hell.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1691,6 +1691,8 @@ _generateApiDocs = do
Lucid.renderToFile "docs/api/index.html" do
doctypehtml_ do
style_ "body {max-width: 40em; margin: .5in auto;} h1,h2,h3,h4,h5,h6 {font-family: Helvetica;} a {color: #1a6e8e}"
head_ do
title_ "Hell's API"
body_ do
h1_ "Hell's API"
p_ $ a_ [href_ "../"] $ "Back to homepage"
Expand Down

0 comments on commit 77d9c38

Please sign in to comment.