Commit ed8d8676 authored by Liam M. Healy's avatar Liam M. Healy
Browse files

Documentation, test

Added "Getting Started" chapter to the documentation. Generated
LaTeX/PDF form of Sphinx documentation. Added definition so that
(asdf:test-system :antik) will work, and tests both ANTIK and GRID
packages.
parent a3142410
;;
;; Liam Healy 2012-02-20 10:14:49EST physical-dimension.asd
;; Time-stamp: <2015-03-12 22:39:51EDT antik.asd>
;; Time-stamp: <2015-11-15 15:05:52EST antik.asd>
;; Copyright 2015 Liam M. Healy
;; Distributed under the terms of the GNU General Public License
......@@ -32,17 +32,21 @@
((:module mathematics
:serial t
:components
((:file "integers")
(:file "trigonometry")))
((:file "integers")
(:file "trigonometry")))
(:module optimize
:components
((:file "one-dim")
(:file "one-dim-pq")
(:file "least-squares")))
((:file "one-dim")
(:file "one-dim-pq")
(:file "least-squares")))
(:module linear-algebra
:components
((:file "linear-algebra")
(:file "linear-algebra-tests")))
((:file "linear-algebra")
(:file "linear-algebra-tests")))
(:module sample
:components
((:file "low-discrepancy-sequence")))))
((:file "low-discrepancy-sequence"))))
:perform (asdf:test-op
(o c)
(uiop:symbol-call :lisp-unit '#:run-tests :all :antik)
(uiop:symbol-call :lisp-unit '#:run-tests :all :grid)))
documentation/build/html/root.html
\ No newline at end of file
documentation/build/latex/Antik.pdf
\ No newline at end of file
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: dfad2d8c6d7df9d960ef1d32f91d9692
config: 0583f5cb403f591c8a4eb836577b4484
tags: 645f666f9bcd5a90fca523b33c5a78b7
.. _systems-packages:
Systems and Packages
====================
......
......@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Antik's documentation!
Antik
=================================
Contents:
......@@ -12,6 +12,7 @@ Contents:
:maxdepth: 2
intro
starting
packages
elemmath
utility
......
Getting Started
=====================
.. highlight:: lisp
Antik is normally installed using Quicklisp_. Once Antik is loaded, it is advisable to set the default package to ``ANTIK-USER`` which is provided to make using Antik easier; see :ref:`systems-packages` for more details. Reader macros are defined by Antik for convenience in specifying physical dimension quantities, dates and times, and grids. These can be enabled with ``set-reader``. This also sets the default floating point read type to ``double-float``::
(ql:quickload :antik)
(in-package :antik-user)
(set-reader)
As a reassurance that the system is installed and working correctly, run the defined regression tests::
> (asdf:test-system :antik)
Unit Test Summary
| 93 assertions total
| 93 passed
| 0 failed
| 0 execution errors
| 0 missing tests
Unit Test Summary
| 88 assertions total
| 88 passed
| 0 failed
| 0 execution errors
| 0 missing tests
T
The first tests definitions in the ``ANTIK`` package and the second in the ``GRID`` package. In examples given in this manual, the ``>`` at the begining of the line is the Lisp REPL_ prompt, indicated the user-typed input follows. Your prompt may differ; for example, it could be the name of the current package, e.g. ``ANTIK-USER>``.
.. _Quicklisp: http://quicklisp.org/
.. _REPL: https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop
.. cl:package:: antik
.. cl:function:: set-reader
.. cl:macro:: set-reader-in-file
/*
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #ffffff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #ffffff;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #ffffff;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
\ No newline at end of file
......@@ -16,7 +16,7 @@
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
......
......@@ -121,7 +121,7 @@
<dl class="function">
<dt id="function:antik:sqrt">
<em class="property">function </em> (<code class="descname">sqrt</code> <em>num</em>)<a class="headerlink" href="#function:antik:sqrt" title="Permalink to this definition"></a></dt>
<dd><p>The square root of the generalized or regular number.</p>
<dd><p>The square root <span class="math">\(\\sqrt{x}\)</span> of the generalized or regular number <span class="math">\(x\)</span>.</p>
</dd></dl>
<dl class="function">
......
......@@ -214,6 +214,14 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="starting.html#function:antik:set-reader">set-reader (Lisp function)</a>
</dt>
<dt><a href="starting.html#macro:antik:set-reader-in-file">set-reader-in-file (Lisp macro)</a>
</dt>
<dt><a href="elemmath.html#function:antik:signum">signum (Lisp function)</a>
</dt>
......@@ -221,12 +229,12 @@
<dt><a href="elemmath.html#function:antik:sin">sin (Lisp function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="elemmath.html#function:antik:sinh">sinh (Lisp function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="elemmath.html#function:antik:sqrt">sqrt (Lisp function)</a>
</dt>
......
......@@ -25,8 +25,8 @@
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="Antik 0 documentation" href="root.html" />
<link rel="next" title="Systems and Packages" href="packages.html" />
<link rel="prev" title="Welcome to Antik’s documentation!" href="root.html" />
<link rel="next" title="Getting Started" href="starting.html" />
<link rel="prev" title="Antik" href="root.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
......@@ -36,10 +36,10 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="packages.html" title="Systems and Packages"
<a href="starting.html" title="Getting Started"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="root.html" title="Welcome to Antik’s documentation!"
<a href="root.html" title="Antik"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......@@ -64,10 +64,10 @@
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="root.html"
title="previous chapter">Welcome to Antik&#8217;s documentation!</a></p>
title="previous chapter">Antik</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="packages.html"
title="next chapter">Systems and Packages</a></p>
<p class="topless"><a href="starting.html"
title="next chapter">Getting Started</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
......@@ -99,10 +99,10 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="packages.html" title="Systems and Packages"
<a href="starting.html" title="Getting Started"
>next</a> |</li>
<li class="right" >
<a href="root.html" title="Welcome to Antik’s documentation!"
<a href="root.html" title="Antik"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......
......@@ -26,7 +26,7 @@
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="Antik 0 documentation" href="root.html" />
<link rel="next" title="Elementary Mathematical Functions" href="elemmath.html" />
<link rel="prev" title="Introduction to Antik" href="intro.html" />
<link rel="prev" title="Getting Started" href="starting.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
......@@ -39,7 +39,7 @@
<a href="elemmath.html" title="Elementary Mathematical Functions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction to Antik"
<a href="starting.html" title="Getting Started"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......@@ -51,7 +51,7 @@
<div class="body" role="main">
<div class="section" id="systems-and-packages">
<h1>Systems and Packages<a class="headerlink" href="#systems-and-packages" title="Permalink to this headline"></a></h1>
<span id="systems-packages"></span><h1>Systems and Packages<a class="headerlink" href="#systems-and-packages" title="Permalink to this headline"></a></h1>
<p>There are several ASDF <a class="reference external" href="https://common-lisp.net/project/asdf/">systems</a> that can be loaded,</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">antik</span></code></li>
......@@ -78,8 +78,8 @@
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="intro.html"
title="previous chapter">Introduction to Antik</a></p>
<p class="topless"><a href="starting.html"
title="previous chapter">Getting Started</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="elemmath.html"
title="next chapter">Elementary Mathematical Functions</a></p>
......@@ -117,7 +117,7 @@
<a href="elemmath.html" title="Elementary Mathematical Functions"
>next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction to Antik"
<a href="starting.html" title="Getting Started"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......
......@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Antik’s documentation! &mdash; Antik 0 documentation</title>
<title>Antik &mdash; Antik 0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
......@@ -46,12 +46,13 @@
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-antik-s-documentation">
<h1>Welcome to Antik&#8217;s documentation!<a class="headerlink" href="#welcome-to-antik-s-documentation" title="Permalink to this headline"></a></h1>
<div class="section" id="antik">
<h1>Antik<a class="headerlink" href="#antik" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Antik</a></li>
<li class="toctree-l1"><a class="reference internal" href="starting.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">Systems and Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="elemmath.html">Elementary Mathematical Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="utility.html">Utility</a></li>
......@@ -75,7 +76,7 @@
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to Antik&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#">Antik</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment