Skip to content

Commit

Permalink
Build and save HTML documentation in docs/ folder
Browse files Browse the repository at this point in the history
For Github Pages integration
  • Loading branch information
xavierleroy committed Oct 13, 2022
1 parent 22f1067 commit 5d776c0
Show file tree
Hide file tree
Showing 16 changed files with 2,844 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ TEXINPUTS=./styles:
TRANSF=tools/transf
TEXQUOTE=tools/texquote2

all: $(TRANSF) $(TEXQUOTE) main.pdf htmlman/index.html
all: $(TRANSF) $(TEXQUOTE) main.pdf ../docs/index.html

main.pdf: main.tex manual.tex
TEXINPUTS=$(TEXINPUTS) latexmk -pdf main.tex

htmlman/index.html: main.tex manual.tex
cd htmlman; \
hevea -I ../styles -I .. -fix ../main.tex && \
../docs/index.html: main.tex manual.tex
cd ../docs && \
hevea -I ../doc/styles -I ../doc -fix ../doc/main.tex && \
hacha main.html

manual.tex: manual.etex
Expand Down
Binary file removed doc/htmlman/contents_motif.gif
Binary file not shown.
Binary file removed doc/htmlman/next_motif.gif
Binary file not shown.
Binary file removed doc/htmlman/previous_motif.gif
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/contents_motif.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="generator" content="hevea 2.35">
<title>Camlidl user's manual
</title>
<link rel="stylesheet" type="text/css" href="main.css">
</head>
<body >
<!--HEVEA command line is: hevea -I ../doc/styles -I ../doc -fix ../doc/main.tex -->
<!--HACHA command line is: hacha main.html -->
<table class="title"><tr><td style="padding:1ex"><h1 class="titlemain">Camlidl user’s manual</h1><h3 class="titlerest">Xavier Leroy <br>
Collège de France and Inria</h3></td></tr>
</table>
<ul>
<li><a href="main001.html">Overview</a>
<ul>
<li><a href="main001.html#sec2">What is IDL?</a>
</li><li><a href="main001.html#sec3">What is COM?</a>
</li></ul>
</li><li><a href="main002.html">IDL syntax</a>
<ul>
<li><a href="main002.html#sec5">Lexical conventions</a>
</li><li><a href="main002.html#sec11">Limited expressions</a>
</li><li><a href="main002.html#sec12">Attributes</a>
</li><li><a href="main002.html#sec13">Types and declarators</a>
</li><li><a href="main002.html#sec14">Structures, unions and enumerations</a>
</li><li><a href="main002.html#sec15">Function declarations</a>
</li><li><a href="main002.html#sec16">Constant definitions</a>
</li><li><a href="main002.html#sec17">IDL files</a>
</li></ul>
</li><li><a href="main003.html">The Caml-IDL mapping</a>
<ul>
<li><a href="main003.html#sec19">Base types</a>
</li><li><a href="main003.html#sec20">Pointers</a>
</li><li><a href="main003.html#sec21">Arrays</a>
</li><li><a href="main003.html#sec22">Big arrays</a>
</li><li><a href="main003.html#sec23">Structs</a>
</li><li><a href="main003.html#sec24">Unions</a>
</li><li><a href="main003.html#sec25">Enums</a>
</li><li><a href="main003.html#sec26">Type definitions</a>
</li><li><a href="main003.html#sec27">Functions</a>
</li><li><a href="main003.html#sec31">Interfaces</a>
</li></ul>
</li><li><a href="main004.html">Using <span class=machine><span class=font-tt>camlidl</span></span></a>
<ul>
<li><a href="main004.html#sec34">Overview</a>
</li><li><a href="main004.html#sec35">Options</a>
</li><li><a href="main004.html#sec36">The <span class=machine><span class=font-tt>camlidldll</span></span> script</a>
</li></ul>
</li><li><a href="main005.html">Hints on writing IDL files</a>
<ul>
<li><a href="main005.html#sec38">Writing an IDL file for a C library</a>
</li><li><a href="main005.html#sec39">Sharing IDL files between MIDL and CamlIDL</a>
</li><li><a href="main005.html#sec40">Dispatch interfaces and type libraries</a>
</li></ul>
</li><li><a href="main006.html">Release notes</a>
</li></ul>
<!--FOOTER-->
<hr class="horizontal-rule" style="height:2px"><blockquote class="quote"><em>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
</em><a href="http://hevea.inria.fr/index.html"><em>H</em><em><span style="font-size:small"><sup>E</sup></span></em><em>V</em><em><span style="font-size:small"><sup>E</sup></span></em><em>A</em></a><em>.</em></blockquote></body>
</html>
156 changes: 156 additions & 0 deletions docs/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
.equationcontainer{position:relative;}
.equationnumber{float:right;left:auto;position:absolute;right:0}
.equationnumber-valign{float:right;left:auto;position:absolute;right:0;margin-top:-0.5em;}
.floatrule{background-color: black; border: none; height: 1px; width: 80%}
.phantom{display: inline-block; visibility: hidden}
.hphantom{display: inline-block; height: 0; visibility: hidden}
.vphantom{display: inline-block; visibility: hidden; width: 0}
.smash{display: inline-block; height: 0; line-height: 0}
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.toc{list-style:none;}
.footnotetext{margin:0ex; padding:0ex;}
div.footnotetext P{margin:0px; text-indent:1em;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{background-color: black; border: none; height: 1px; margin: 1em auto 1em 0px; width: 40%}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:2ex auto;text-align:center}
.titlemain{margin:1ex 2ex 2ex 1ex;}
.titlerest{margin:0ex 2ex;}
.center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
.flushright{text-align:right;margin-left:auto;margin-right:0ex;}
div table{margin-left:inherit;margin-right:inherit;margin-bottom:2px;margin-top:2px}
td table{margin:auto;}
table{border-collapse:collapse;}
td{padding:0;}
.cellpadding0 tr td{padding:0;}
.cellpadding1 tr td{padding:1px;}
pre{text-align:left;margin-left:0ex;margin-right:auto;}
blockquote{margin-left:4ex;margin-right:4ex;text-align:left;}
td p{margin:0px;}
.quote{margin-left:3em;margin-right:3em;text-align:inherit;text-indent:0pt}
.quotation{margin-left:3em;margin-right:3em;text-align:inherit;text-indent:1.5em}
.verse{margin-left:3em;margin-right:3em;text-indent:1.5em hanging each-line}
.parbox{box-sizing: border-box;
display: inline-block;
text-indent: 0;
}
.rule-rect{fill: black;}
.lrbox{box-sizing:border-box;display:inline-block;overflow:visible;white-space:nowrap;}
.center-lrbox{display:inline-block;margin-left:50%;transform:translateX(-50%);}
.makebox{}
.framebox{border:1px solid black;padding:0.25em;}
.vertical-rule{border:none;width:2px;background-color:black;}
.horizontal-rule{border:none;background-color:black;}
.hrule{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;line-height:1.1;width:auto; empty-cells:show; border:2px solid red;}
.vdcell{white-space:nowrap;padding:0px; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;line-height:1.1;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginpar{border:solid thin black; margin-bottom:1ex; width:20%; text-align:left;}
.marginparleft{float:left; clear:left; margin-left:0ex; margin-right:1ex;}
.marginparright{float:right; clear:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:2ex auto;text-align:center}
.syntax-token{color:blue;font-family:monospace}
a.syntax:link{color:maroon;text-decoration:underline}
a.syntax:visited{color:maroon;text-decoration:underline}
a.syntax:hover{color:black;text-decoration:none;background-color:#FF6060}
.nonterminal{color:maroon;font-style:oblique}
a.section-anchor::after{content:"🔗";
font-size:smaller;
margin-left:-1.5em;
padding-right:0.5em;
}
a.section-anchor{visibility:hidden;
color:grey !important;
text-decoration:none !important;
}
*:hover>a.section-anchor{visibility:visible;
}
a:link{color:#4286f4;text-decoration:underline;}
a:visited{color:#0d46a3;text-decoration:underline;}
a:hover{color:black;text-decoration:underline;}
@media all{@font-face {
/* fira-sans-regular - latin */
font-family: 'Fira Sans';
font-style: normal;
font-weight: 400;
src: url('fonts/fira-sans-v8-latin-regular.eot'); /* IE9 Compat Modes */
src: local('Fira Sans Regular'), local('FiraSans-Regular'),
url('fonts/fira-sans-v8-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
url('fonts/fira-sans-v8-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */
url('fonts/fira-sans-v8-latin-regular.woff') format('woff'), /* Modern Browsers */
url('fonts/fira-sans-v8-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */
url('fonts/fira-sans-v8-latin-regular.svg#FiraSans') format('svg'); /* Legacy iOS */
}}
body{max-width:750px;
width: 85%;
margin: auto;
background: #f7f7f7;
margin-top: 80px;
font-size: 1rem;
}
.maintitle{font-family: "Fira Sans", sans-serif;
text-align: center;
}
h1, h2, h3{font-family: "Fira Sans", sans-serif;
font-weight: normal;
border-bottom: 1px solid black;
}
div.ocaml{margin:2ex 0px;
font-size: 1rem;
background: beige;
border: 1px solid grey;
padding: 10px;
overflow-y:auto;
display:flex;
flex-direction: column;
flex-wrap: nowrap;
}
div.ocaml .pre{white-space: pre;
font-family: monospace;
}
.ocamlkeyword{font-weight:bold;
}
.ocamlhighlight{font-weight:bold;
text-decoration:underline;
}
.ocamlerror{font-weight:bold;
color:red;
}
.ocamlwarning{font-weight:bold;
color:purple;
}
.ocamlcomment{color:grey;
}
.ocamlstring{opacity:0.75;
}
#cc_license_logo{float:left;
margin-right: 1em;
}
p,ul{line-height:1.3em}
.cellpadding1 tr td{padding:1px 4px}
div.caml-output{color:maroon;}
div.caml-example.toplevel div.caml-input{color:#006000;}
.ocamlprompt{color:black;}
.osvariant{font-family:sans-serif}
.tableau, .syntax, .syntaxleft{/* same width as body */
max-width: 750px;
overflow-y: auto;
}
.th{font-size:small;}
.li-links{margin:0ex 0ex;}
.font-tt{font-family:monospace;}
.font-it{font-style:italic;}
.font-bold{font-weight:bold;}
.font-sl{font-style:oblique;}
Loading

0 comments on commit 5d776c0

Please sign in to comment.