Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation | Adds HTML docs #41

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# ocaml-pop3

A pure OCaml implementation of a POP3 server ([RFC 1939](https://tools.ietf.org/html/rfc1939)).
A pure OCaml implementation of [RFC 1939](https://tools.ietf.org/html/rfc1939).

[![Build status](https://ci.appveyor.com/api/projects/status/gywwy2ro4690bvay/branch/master?svg=true)](https://ci.appveyor.com/project/m-harrison/ocaml-pop3/branch/master)

## Acknowledgements

### Documentation

Documentation was automatically generated from sources via [odoc](https://github.com/ocaml/odoc).

### .gitignore

The `.gitignore` file for this repository was generated by [gitignore.io](https://www.gitignore.io/). To generate the same file go [here](https://www.gitignore.io/api/ocaml).
2 changes: 2 additions & 0 deletions docs/html/highlight.pack.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions docs/html/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
<body>
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="pop3/index.html">pop3</a> <span class="version">0.1</span></li>
<li><a href="pop3-server/index.html">pop3-server</a> <span class="version">0.1</span></li>
<li><a href="pop3-server-unix/index.html">pop3-server-unix</a> <span class="version">0.1</span></li>
</ol>
</div>
</body>
</html>
Loading