Skip to content

Commit

Permalink
Deployed 5f1775d with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
jimfinnis committed Jul 16, 2024
1 parent 211bab6 commit 1c5952e
Show file tree
Hide file tree
Showing 8 changed files with 274 additions and 3 deletions.
9 changes: 8 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,10 @@

<li class="nav-item" data-level="1"><a href="#pcot-the-pancam-operations-toolkit" class="nav-link">PCOT - the PanCam Operations Toolkit</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#updating" class="nav-link">Updating</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#reporting-bugs" class="nav-link">Reporting bugs</a>
<ul class="nav flex-column">
</ul>
Expand Down Expand Up @@ -198,6 +202,9 @@ <h1 id="pcot-the-pancam-operations-toolkit">PCOT - the PanCam Operations Toolkit
<a href="autodocs/" class="btn btn-primary" role="button">Automatically generated node and function docs</a>
</div>

<h2 id="updating">Updating</h2>
<p>Existing PCOT installs can be updated by following the instructions
<a href="userguide/update/">here</a>.</p>
<h2 id="reporting-bugs">Reporting bugs</h2>
<p>There are known issues which can stop PCOT running - see
<a href="gettingstarted/issues/">issues</a>. If your problem isn't described there
Expand Down Expand Up @@ -287,5 +294,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-07-16 12:15:16.268674+00:00
Build Date UTC : 2024-07-16 14:09:20.558254+00:00
-->
1 change: 1 addition & 0 deletions index.md~
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ from the ExoMars PANCAM instrument - but we also support
* ENVI provided the images are 32-bit float BSQ
* RGB PNGs
* multispectral images made of multiple monochrome PNGs
* multispectral images made of monochrome raw files in various formats
* and adding new PDS4 formats should be relatively straightforward
* There are probably a *lot* of useful operations missing
* There are certainly a *lot* of bugs.
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.
1 change: 1 addition & 0 deletions userguide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ <h2 id="contents">Contents</h2>
</ul>
<h3 id="special-topics">Special topics</h3>
<ul>
<li><a href="update/">Updating PCOT</a></li>
<li><a href="multifile">Using the multifile input to read multispectral data from BMP, PNG etc.</a></li>
<li><a href="expr/">Using the <em>expr</em> node to perform mathematical operations</a></li>
</ul>
Expand Down
5 changes: 4 additions & 1 deletion userguide/index.md~
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Overview

These pages are a reference guide to PCOT.
These pages are a reference guide to the PCOT application. If you
want to read about using PCOT as a Python library, documentation
is available [in the Developer's Guide](../devguide/library/).
At the moment, this consists of in-depth pages on particular aspects of PCOT.
For introductory information see
the [Getting Started](../gettingstarted/) section, which will tell you how
Expand All @@ -16,6 +18,7 @@ to install and run PCOT and give you a tutorial covering the basics.
* [Using the multifile input to read multispectral data from BMP, PNG etc.](multifile)
* [Using the *expr* node to perform mathematical operations](expr.md)


### Autodocs
* [Automatically generated documentation](autodocs) for nodes, expression functions and
expression properties.
8 changes: 8 additions & 0 deletions userguide/update.md~
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Updating PCOT

Updating an existing PCOT install should be fairly simple.

* Go into the directory where you installed PCOT before (where you did the `git clone` command)
* Type `git pull` - this should pull the latest release
* Type `poetry install` - this should check for any updated packages and download them

251 changes: 251 additions & 0 deletions userguide/update/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html lang="en">
<head>

<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">



<link rel="shortcut icon" href="../../img/favicon.ico">
<meta name="robots" content="noindex,nofollow">

<title>Updating PCOT - PCOT Documentation</title>

<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/font-awesome.min.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<link rel="stylesheet" href="../../css/lightbox.min.css">
<link rel="stylesheet" href="../../css/site.css">


<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script src="../../js/lightbox-plus-jquery.min.js"></script>

</head>

<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="../..">PCOT Documentation</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>

<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Getting Started <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../../gettingstarted/" class="dropdown-item">Overview</a>
</li>

<li>
<a href="../../gettingstarted/installrun/" class="dropdown-item">Installing and running</a>
</li>

<li>
<a href="../../gettingstarted/concepts/" class="dropdown-item">PCOT concepts</a>
</li>

<li>
<a href="../../gettingstarted/tutorial/" class="dropdown-item">Tutorial</a>
</li>

<li>
<a href="../../gettingstarted/inputs/" class="dropdown-item">Loading other image formats</a>
</li>

<li>
<a href="../../gettingstarted/help/" class="dropdown-item">Getting help</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../" class="dropdown-item">Overview</a>
</li>

<li>
<a href="../principles/" class="dropdown-item">Operating principles</a>
</li>

<li>
<a href="../canvas/" class="dropdown-item">The Canvas</a>
</li>

<li>
<a href="../globalcontrols/" class="dropdown-item">Global Controls</a>
</li>

<li>
<a href="../multifile/" class="dropdown-item">Reading images from multiple files</a>
</li>

<li>
<a href="../expr/" class="dropdown-item">The "expr" node for mathematical expressions</a>
</li>

<li>
<a href="../../autodocs/" class="dropdown-item">Autodocs</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer's Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../../devguide/" class="dropdown-item">Overview</a>
</li>

<li>
<a href="../../devguide/library/" class="dropdown-item">Using PCOT as a library</a>
</li>

<li>
<a href="../../devguide/plugins/" class="dropdown-item">Writing PCOT plugins</a>
</li>
</ul>
</li>
<li class="navitem">
<a href="../../roadmap/" class="nav-link">Roadmap</a>
</li>
<li class="navitem">
<a href="../../gettingstarted/issues/" class="nav-link">Known issues</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
</ul>
</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>


<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#updating-pcot" class="nav-link">Updating PCOT</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">

<h1 id="updating-pcot">Updating PCOT</h1>
<p>Updating an existing PCOT install should be fairly simple.</p>
<ul>
<li>Go into the PCOT root directory - this is the directory which contains
PCOT on your machine, and is usually called <code>PCOT</code>.
It should contain directories called <code>src</code> and <code>tests</code>.</li>
<li>Type <code>git pull</code> - this should get the latest release</li>
<li>Type <code>poetry install</code> - this should check for any updated packages and download them</li>
</ul></div>
</div>
</div>

<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../../js/jquery-3.6.0.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script>
var base_url = "../..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../../js/base.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
<script src="../../search/main.js"></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>

</body>
</html>

0 comments on commit 1c5952e

Please sign in to comment.