Skip to content

Commit

Permalink
First commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
dbuenzli committed Sep 23, 2016
0 parents commit caeb272
Show file tree
Hide file tree
Showing 84 changed files with 7,773 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
@@ -0,0 +1,8 @@
_build
tmp
*~
\.\#*
\#*#
*.install
*.native
*.byte
13 changes: 13 additions & 0 deletions .merlin
@@ -0,0 +1,13 @@
PKG bytes uchar result rresult
PKG fmt fmt.tty fmt.cli
PKG logs logs.fmt logs.cli
PKG astring fpath bos bos.setup cmdliner
PKG topkg.care
PKG compiler-libs.common
PKG mtime.os
PKG webbrowser webbrowser.cli
PKG asetmap
S src
S src-bin
S test
B _build/**
1 change: 1 addition & 0 deletions .ocp-indent
@@ -0,0 +1 @@
strict_with=always,match_clause=4,strict_else=never
4 changes: 4 additions & 0 deletions CHANGES.md
@@ -0,0 +1,4 @@
vX.Y.Z YYYY-MM-DD Location
--------------------------

First release.
13 changes: 13 additions & 0 deletions LICENSE.md
@@ -0,0 +1,13 @@
Copyright (c) 2016 Daniel C. Bünzli

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
43 changes: 43 additions & 0 deletions README.md
@@ -0,0 +1,43 @@
opkg — Mine installed OCaml packages
-------------------------------------------------------------------------------
%%VERSION%%

opkg is a library and command line tool to mine installed OCaml
packages. It supports package distribution documentation and metadata
lookups and generates cross-referenced API documentation.

opkg is distributed under the ISC license.

Homepage: http://erratique.ch/software/opkg
Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`

## Important warning

opkg is a work in progress. The command line interface and API may
change without notice in the future.

## Installation

opkg can be installed with `opam`:

opam install opkg

If you don't use `opam` consult the [`opam`](opam) file for build
instructions.

## Documentation

opkg is extensively documented in man pages available through it's help
system. Type:

```
opkg help basics # to get started
opkg help packaging # for packaging conventions
opkg help # for more help
```

The documentation and API reference is automatically generated by from
the source interfaces. It can be consulted [online][doc] or via `opkg
doc opkg`.

[doc]: http://erratique.ch/software/opkg/doc
12 changes: 12 additions & 0 deletions _tags
@@ -0,0 +1,12 @@
true : bin_annot, safe_string
true : package(rresult asetmap fpath bos.setup mtime.os)
true : package(opam-lib compiler-libs.common)

<src> : include
<src/opkg_cli.*> : package(cmdliner)

<src-bin> : include
<src-bin/*> : package(cmdliner fmt.tty fmt.cli logs.fmt logs.cli), \
package(webbrowser webbrowser.cli)

<test> : include
2 changes: 2 additions & 0 deletions doc/api.odocl
@@ -0,0 +1,2 @@
Opkg
Opkg_cli
3 changes: 3 additions & 0 deletions doc/dev.odocl
@@ -0,0 +1,3 @@
Opkg
Opkg_cli
Opkg_trails
1 change: 1 addition & 0 deletions doc/style.css
219 changes: 219 additions & 0 deletions etc/ocamldoc.css
@@ -0,0 +1,219 @@
@charset "UTF-8";
/* Copyright (c) 2016 Daniel C. Bünzli. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. */

/* Reset a few things. */

html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,
a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,
small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,
fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,
article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,
menu,nav,output,ruby,section,summary,time,mark,audio,video
{ margin: 0; padding: 0; border: 0; outline: 0; font-size: 100%;
font: inherit; line-height: inherit; vertical-align: baseline;
text-align: inherit; color: inherit; background: transparent; }

table { border-collapse: collapse; border-spacing: 0; }

html { box-sizing: border-box }
*, *:before, *:after { box-sizing: inherit; }

/* Basic page layout */

body
{ font-family: Helvetica, "DejaVu Sans", Arial, sans-serif;
font-weight: normal;
font-size: 0.875rem;
line-height: 1.25rem;
text-align: left;
min-width: 40ex;
max-width: 78ex;
padding: 1.25rem;
margin-left: 3.75rem;
color: #222; background: #FAFAFA; }

b { font-weight: bold }
em { font-style: italic }

.superscript { vertical-align: super; }
.subscript { vertical-align: sub; }
.superscript, .subscript
{ font-size : 0.75rem; line-height: 0; margin-left: 0.4ex; }

/* ocamldoc markup workaround hacks.
See http://caml.inria.fr/mantis/view.php?id=7351 */

hr
{ display: none } /* Would be nice to have but we cannot get that to
interact well with our h1's because of br markup noise */

br { display: none } /* Annoying, hide them. */
code br { display: block } /* Except in signatures. */

.codepre br + br { display: none }
h1 + pre { margin-bottom: 0.625rem } /* Toplevel module description */

/* Links and anchors */

a { text-decoration:none; color:#2C5CBD; }
a:hover { box-shadow:0 1px 0 0 #2C5CBD; }
*:target { background-color: #FFFFCC; } /* Anchor highlight */

/* Sections and document divisions
Many of the modules of the stdlib start at h6, we make it look like
h1 and the .7 div (sic) like h2. */

h1, h2, h3, h6, .h7
{ font-weight: bold; padding-top: 0.625rem; margin-top: 0.625rem }

h1, h6
{ font-size: 1.25rem;
line-height: 2.4375rem; /* 2.5 rem - border width */
border-top-style: solid;
border-width: 1px;
border-color: #DDDDDD; }

h1 + p { margin-top: 0.625rem; }
br + pre { margin-top: 0.625rem; } /* Ideally this would be h1 + pre */

h2, .h7 { font-size: 1.125rem; }
h1 + h2, h6 + .h7 { margin-top: 0.625rem; padding-top: 0rem; }

/* Paragraphs, lists and tables */

p { margin-top: 1.25rem }
e.info p, li p { margin-top: 0.625rem }

table { margin-top: 0.625rem }
.info.module.top { margin-left: 0em } /* Toplevel module description */
.info { margin-left: 1ex; margin-top: 0.15625rem }

td .info { margin:0; padding:0; margin-left: 2em;} /* Description in indexes */

ul, ol { margin-top: 0.625rem; margin-bottom: 0.625rem;
list-style-position: outside }
ul + p, ol + p { margin-top: 0em }
ul { list-style-type: square }

ul > li { margin-left: 1.375rem; }
ol > li { margin-left: 1.7rem; }

/* Preformatted and code */

tt, code, pre
{ font-family: Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono",
monospace;
font-weight: normal;
font-size: 0.75rem; }

h1 tt, h1 code, h6 tt, h6 code { font-size: 1.125rem }
h2 tt, h2 code, .h7 tt, .h7 code { font-size: 1rem }

pre { margin-top: 1.25rem; }

pre.verbatim, pre.codepre
{ padding-left: 0.25rem;
padding-right: 0.25rem;
margin-left: -0.25rem;
margin-right: -0.25rem;
padding-bottom: 0.3125rem;
padding-top: 0.3125rem;
margin-bottom: 0.265rem; /* Sometimes there's text without <p>
http://caml.inria.fr/mantis/view.php?id=7353 */
line-height: 1.1875rem;
background: #F1F1F1; }

pre .code { background: inherit; }
.code {
/* If we can avoid it. */
/* background: #F1F1F1;
padding-top:1px; padding-bottom:1px;
padding-left:1px; padding-right:1px;
border-radius:2px; */ }

.keyword { font-weight: bold }
.comment { color: #888; font-style:italic }
.constructor { color: #208000; }
.string { color: brown; }
.warning { color: crimson; }

.typetable { margin-top: 0em }

.paramstable code { margin-left: 1ex; margin-right: 1ex; }
.sig_block { margin-left: 1em }

/* Images */

img { margin-top: 1.25rem }

/* Opkg */

h1 nav { display: inline; font-size: 0.875rem; font-weight: normal; }

ul.indexlist { list-style-type: none }
ul.indexlist li { margin-left: 0em; }

dl.opkg-info { margin-top: 0.625rem; }
dl.opkg-info dt { float: left; clear: left; width: 12ex; font-style: italic }
dl.opkg-info dd { margin-left: 12ex;}

.opkg-info ul { list-style-type: none; margin: 0; padding: 0; display: inline }
.opkg-info ul li { display: inline-block; margin: 0; padding:0;
margin-right: 1ex;}

.opkg-name nav { margin-top: 0.625rem; }
.opkg-name nav a { text-transform: uppercase; font-size: 1.125rem;
margin-right:1ex; color: #222; display: inline-block; }

.opkg-name ol { list-style-type: none; margin: 0; }
.opkg-name > ol { margin-top: 0.625rem; }
.opkg-name li { margin-left: 0}

ol.opkg-errors { list-style-type: none; }
ol.opkg-errors li { margin-left: 0; }

.opkg-tag nav { margin-top: 0.625rem }
.opkg-tag nav a { margin-right:1ex; color: #222; display: inline-block; }
.opkg-tag ol { list-style-type: none; margin: 0; }
.opkg-tag li { margin-left: 0; padding:0}
.opkg-tag > ol { margin-top: 0.625rem; }
.opkg-tag > ol > li { margin-top: 0.625rem; }
.opkg-tag > ol > li > span,
.opkg-tag > ol > li > ol,
.opkg-tag > ol > li > ol > li
{ display: inline-block; margin-right: 1ex; }

/* Mobile adjustements
Can't really do anything we need to get a <meta> for viewport generated */

@media only screen and (max-width:78ex) /* (max-device-width: 480px) */

{
body { margin: auto; }
}

/* Print adjustements */

@media print
{
body { color: black; background: white; }
.navbar { visibility: hidden; }
}

/*---------------------------------------------------------------------------
Copyright (c) 2016 Daniel C. Bünzli
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
---------------------------------------------------------------------------*/

0 comments on commit caeb272

Please sign in to comment.