Skip to content

Commit

Permalink
documentation, README, wheel in requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
aless80 committed Mar 2, 2021
1 parent 2b9818e commit 8b2db74
Show file tree
Hide file tree
Showing 41 changed files with 121 additions and 212 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ index entries, figures, tables, and admonitions).

### Installation

DocOnce is a Python 3 package that can be installed with `pip` or `conda`. Refer to the [manual](https://doconce.github.io/doconce/doc/pub/manual/manual.html#install:doconce) for carrying out a comprehensive installation.

DocOnce is a Python 3 package that can be installed with `pip` or `conda`. This procedure installs a minimal number of dependencies.

##### Preliminary steps
* The `python -V` and `pip -V` commands should refer to Python 3.x. If that is not the case, you might want to use the `pip3` and `python3` commands in the following instructions.
Expand All @@ -54,7 +53,7 @@ conda activate doconce
conda install pip
```

Install DocOnce and its dependencies:
Install DocOnce:
```
pip install DocOnce
```
Expand All @@ -69,11 +68,25 @@ python -m venv venv
. venv/bin/activate
```

Install DocOnce and its dependencies:
Install DocOnce:
```
pip install DocOnce
```

##### Comprehensive installation

For carrying out a comprehensive installation clone this repository
on the local computer and run `pip install` in that directory:

```
git clone git@github.com:doconce/doconce.git
cd doconce
pip install -r requirements.txt
python setup.py install
```

Also refer to the [manual](https://doconce.github.io/doconce/doc/pub/manual/manual.html#install:doconce) to upgrade your DocOnce software to the latest update.


### Highlights

Expand Down
4 changes: 2 additions & 2 deletions doc/pub/manual/html/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jQuery.fn.highlightText = function(text, className) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("https://www.w3.org/2000/svg", "tspan");
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
Expand All @@ -87,7 +87,7 @@ jQuery.fn.highlightText = function(text, className) {
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("https://www.w3.org/2000/svg", "rect");
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
Expand Down
6 changes: 3 additions & 3 deletions doc/pub/manual/html/_static/underscore-1.3.1.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Portions of Underscore are inspired or borrowed from Prototype,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// https://documentcloud.github.com/underscore
// http://documentcloud.github.com/underscore

(function() {

Expand Down Expand Up @@ -446,7 +446,7 @@

// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](https://docs.python.org/library/functions.html#range).
// [the Python documentation](http://docs.python.org/library/functions.html#range).
_.range = function(start, stop, step) {
if (arguments.length <= 1) {
stop = start || 0;
Expand Down Expand Up @@ -668,7 +668,7 @@
// Internal recursive comparison function.
function eq(a, b, stack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the Harmony `egal` proposal: https://wiki.ecmascript.org/doku.php?id=harmony:egal.
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
if (a === b) return a !== 0 || 1 / a == 1 / b;
// A strict comparison is necessary because `null == undefined`.
if (a == null || b == null) return a === b;
Expand Down
2 changes: 1 addition & 1 deletion doc/pub/manual/html/_static/underscore.js

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

66 changes: 14 additions & 52 deletions doc/pub/manual/html/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -378,9 +378,7 @@
</ul>
</li>
<li><a class="reference internal" href="#installation-of-doconce-and-its-dependencies">Installation of DocOnce and its Dependencies</a><ul>
<li><a class="reference internal" href="#doconce">DocOnce</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a><ul>
<li><a class="reference internal" href="#python-v2-7">Python v2.7</a></li>
<li><a class="reference internal" href="#preprocessors">Preprocessors</a></li>
<li><a class="reference internal" href="#bibliography">Bibliography</a></li>
<li><a class="reference internal" href="#image-file-handling">Image file handling</a></li>
Expand Down Expand Up @@ -459,7 +457,7 @@ <h1>DocOnce Manual<a class="headerlink" href="#doconce-manual" title="Permalink
<dd class="field-odd"><p>Hans Petter Langtangen, Kristian Gregorius Hustad</p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>Mar 1, 2021</p>
<dd class="field-even"><p>Mar 2, 2021</p>
</dd>
</dl>
<div class="admonition warning">
Expand Down Expand Up @@ -9563,61 +9561,34 @@ <h3><code class="docutils literal notranslate"><span class="pre">doconce</span>
</div>
<div class="section" id="installation-of-doconce-and-its-dependencies">
<span id="install-doconce"></span><h2>Installation of DocOnce and its Dependencies<a class="headerlink" href="#installation-of-doconce-and-its-dependencies" title="Permalink to this headline">¶</a></h2>
<p id="index-380">Below, we explain the manual installation of all software that may be
needed when working with DocOnce documents.
The impatient way to install everything that is needed is to use
Anaconda Python and the <code class="docutils literal notranslate"><span class="pre">conda</span></code> program:</p>
<p>DocOnce is available from the <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code> channel. To add the <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code> channel and subsequently install DocOnce, run the following commands.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Terminal&gt; conda config --add channels conda-forge
Terminal&gt; conda install doconce
</pre></div>
</div>
<p>If you do not want to use Anaconda and are
on a Debian-based Linux
computer (running, e.g., Ubuntu), you can instead run the Bash script
<a class="reference external" href="https://raw.githubusercontent.com/doconce/doconce/master/doc/src/manual/install_doconce.sh">install_doconce.sh</a> or the equivalent Python script
<a class="reference external" href="https://raw.githubusercontent.com/doconce/doconce/master/doc/src/manual/install_doconce.py">install_doconce.py</a>.
These scripts give a comprehensive installation. Some users will prefer to
install just what is needed for them, and this is explained below.</p>
<div class="admonition-version-control-systems-are-needed admonition">
<p class="admonition-title">Version control systems are needed</p>
<p>The coming installation instructions require that the version control systems
Subversion, Mercurial, and Git are installed on your computer.</p>
</div>
<div class="admonition-what-about-mac-and-windows admonition">
<p class="admonition-title">What about Mac and Windows</p>
<p>DocOnce is primarily tested on GNU/Debian Linux systems, but also to
a minor extent on Mac OS X. Experience with Windows is limited.
Since most packages are Python-based and can be installed via <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code>
no problems should arise on Mac and Windows. However, some of the
image processing tools and spell checking apply Unix-specific software.</p>
</div>
<p>You can omit reading the next sections if you rely on <code class="docutils literal notranslate"><span class="pre">conda</span></code> or
<code class="docutils literal notranslate"><span class="pre">apt-get</span> <span class="pre">install</span></code> commands in the Bash script for installing DocOnce.</p>
<div class="section" id="doconce">
<h3>DocOnce<a class="headerlink" href="#doconce" title="Permalink to this headline">¶</a></h3>
<p>DocOnce itself is pure Python code hosted at <a class="reference external" href="https://github.com/doconce/doconce">https://github.com/doconce/doconce</a>.
<p>DocOnce is hosted on PyPi at URL: <a class="reference external" href="https://pypi.org/project/DocOnce/1.5.5/">https://pypi.org/project/DocOnce/1.5.5/</a> and GitHub at <a class="reference external" href="https://github.com/doconce/doconce">https://github.com/doconce/doconce</a>.
Installation can be done via</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/doconce/doconce
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pip install DocOnce
# or if doconce is already installed
pip install git+https://github.com/doconce/doconce --upgrade
pip install DocOnce --upgrade
</pre></div>
</div>
<p>However, the recommended approach is to have a copy of the source on
the local computer and run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> in that directory:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>git clone git@github.com:doconce/doconce.git
cd doconce
pip install .
cd ..
pip install -r requirements.txt
python setup.py install
</pre></div>
</div>
<p>Since DocOnce is frequently updated, it becomes necessary to ensure
that you work with the most recent version:</p>
<p>Since DocOnce is frequently updated, you can update your software to the most recent update:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cd doconce
git pull origin master
pip install --upgrade .
</pre></div>
</div>
<div class="admonition-what-about-mac-and-windows admonition">
<p class="admonition-title">What about Mac and Windows</p>
<p>DocOnce is primarily tested on GNU/Debian Linux systems, but also to
a minor extent on Mac OS X. Experience with Windows is limited.
Since most packages are Python-based and can be installed via <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code>
no problems should arise on Mac and Windows. However, some of the
image processing tools and spell checking apply Unix-specific software.</p>
</div>
<div class="section" id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
Expand All @@ -9627,15 +9598,6 @@ <h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to t
(LaTeX, Sphinx, reStructuredText) and assisting utilities such
as preprocesors, spellcheck, file differences, bibliographies,
and so on, a lot of extra software must be installed.</p>
<div class="section" id="python-v2-7">
<h4>Python v2.7<a class="headerlink" href="#python-v2-7" title="Permalink to this headline">¶</a></h4>
<p>First you need Python version 2.7 and the <code class="docutils literal notranslate"><span class="pre">pip</span></code> installation program.
Unless you already have these, we recommend to install a comprehensive
Python bundle like <a class="reference external" href="https://store.continuum.io/cshop/anaconda/">Anaconda</a>.</p>
<p>You do not need more software if you avoid using preprocessors, there
is no bibliography, and you stick to the output formats LaTeX and HTML
(you need of course LaTeX installed to process <code class="docutils literal notranslate"><span class="pre">.tex</span></code> files).</p>
</div>
<div class="section" id="preprocessors">
<h4>Preprocessors<a class="headerlink" href="#preprocessors" title="Permalink to this headline">¶</a></h4>
<p>If you make use of the <a class="reference external" href="https://github.com/doconce/preprocess">Preprocess</a>
Expand Down
2 changes: 1 addition & 1 deletion doc/pub/manual/html/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 8b2db74

Please sign in to comment.