Skip to content

Commit ab1e828

Browse files
ulrikstridGithub Runner
ulrikstrid
and
Github Runner
authored
Odig docs and update deps (reason-native-web#42)
* Build odig with docer * Try to get a better docker * Fix pinning, thanks @anuragsoni * clean up docs * More fixes * Add more libraries to the odig list * Fix updated pins * Add github pages release * Bump versions everywhere * Bump versions * Move stuff instead * fix css link in index.html * Do a git pull before cleaning * Update lockdir * Slight cleanup Co-authored-by: Github Runner <[email protected]>
1 parent e1a75ea commit ab1e828

File tree

36 files changed

+385
-300
lines changed

36 files changed

+385
-300
lines changed

‎.ci/build-docs.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.ci/publish-api-docs.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎.ci/upstream-docs.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎.dockerignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
esy.lock
2+
_esy
3+
_build
4+
_opam
5+
_docs
6+
.ci
7+
.github
8+
node_modules
9+
.git

‎.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
*.install
22
*.merlin
3+
.DS_Store
34
_esy
5+
_docs
6+
_build
7+
_opam
8+
*/.opam-switch/*
49
node_modules
510
junit.xml
611

712
*/esy.lock
813
*.esy.lock
14+
15+
vendor
16+
.vscode/*

‎.vscode/settings.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎Dockerfile.odig

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
FROM ocaml/opam2
2+
3+
ARG ODOC_THEME=odig.dark
4+
ENV OPAMYES=true
5+
6+
RUN opam switch create . ocaml-base-compiler.4.09.1
7+
RUN opam depext conf-pkg-config conf-m4 conf-libssl
8+
9+
RUN opam install odig
10+
11+
COPY dune-project morph.opam morph_graphql_server.opam ./
12+
13+
RUN opam update
14+
15+
RUN opam install --deps-only .
16+
17+
COPY ./morph_graphql_server ./morph_graphql_server
18+
COPY ./morph ./morph
19+
20+
RUN opam pin -w morph . -k path
21+
RUN opam pin -w morph_graphql_server . -k path
22+
23+
RUN opam exec -- odig odoc -v --odoc-theme=${ODOC_THEME} \
24+
--index-title='Morph docs' \
25+
--no-pkg-deps morph morph_graphql_server piaf bigstringaf gluten gluten-lwt gluten-lwt-unix lwt httpaf httpaf-lwt httpaf-lwt-unix hmap graphql graphql-lwt || true

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.4.0
1+
0.4.1

‎azure-pipelines.yml

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ stages:
1818
- template: .ci/build-platform.yml
1919
parameters:
2020
installFolderPath: "/3______________________________________________________________/i"
21-
- template: .ci/build-docs.yml
2221
- template: .ci/utils/prepare-cache.yml
2322

2423
- job: macOS
@@ -43,30 +42,3 @@ stages:
4342
# parameters:
4443
# esyLockPath: $(Build.SourcesDirectory)\esy.lock\index.json
4544
# installFolderPath: \3_
46-
47-
- stage: Publish_docs
48-
displayName: Publish documentation
49-
dependsOn: [Build]
50-
jobs:
51-
- deployment: Publish_docs
52-
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
53-
displayName: Publish docs to Github
54-
environment: gh-pages
55-
pool:
56-
vmImage: ubuntu-16.04
57-
strategy:
58-
runOnce:
59-
deploy:
60-
steps:
61-
- template: .ci/publish-api-docs.yml
62-
- deployment: Upstream_docs
63-
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
64-
displayName: Upstream docs to reason-native-web.github.io
65-
environment: reason-native-web_github_io
66-
pool:
67-
vmImage: ubuntu-16.04
68-
strategy:
69-
runOnce:
70-
deploy:
71-
steps:
72-
- template: .ci/upstream-docs.yml

‎docs/index.html

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<title>index</title>
5-
<link rel="stylesheet" href="./odoc.css" />
5+
<link
6+
rel="stylesheet"
7+
type="text/css"
8+
media="screen, print"
9+
href="odoc-theme/odoc.css"
10+
/>
611
<meta charset="utf-8" />
712
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
813
</head>
@@ -11,20 +16,20 @@
1116
<h1>Morph</h1>
1217
<p>
1318
Morph is a web framework built on the notion of transforming requests
14-
and responses.
19+
and responses. It is built ontop of Piaf as a high performance server
20+
implementation that abstracts some of the lower level concepts.
1521
</p>
1622
<div class="by-name">
1723
<h2>Package documentation</h2>
18-
<ol>
19-
<li><a href="morph/index.html">morph</a> - Core package</li>
20-
<li>
21-
<a href="morph_client/index.html">morph_client</a> - HTTP client
22-
</li>
23-
<li>
24-
<a href="morph_server/index.html">morph_server</a> - Creating
25-
servers
26-
</li>
27-
</ol>
24+
<p>
25+
Morph currently has 2 packages:
26+
<ul>
27+
<li><a href="morph/index.html">Morph</b></a>, the core package</li>
28+
29+
<li><a href="morph_graphql_server/index.html">morph_graphql_server</a>,
30+
a nice way to build graphql servers ontop of Morph.</li>
31+
</ul>
32+
</p>
2833
</div>
2934
</main>
3035
</body>

0 commit comments

Comments
 (0)