Skip to content

Commit d331915

Browse files
dwest77adwest77a
committed
Added basic documentation
1 parent 03efbe3 commit d331915

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+6790
-0
lines changed

‎docs/.DS_Store‎

6 KB
Binary file not shown.

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/build/.DS_Store‎

6 KB
Binary file not shown.

‎docs/build/doctrees/environment.pickle‎

138 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree‎

67.2 KB
Binary file not shown.

‎docs/build/html/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 787abf6e29d0bf20c90be1ee81fbf55e
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_images/ceda.png‎

48.1 KB
Loading

‎docs/build/html/_images/ncas.png‎

108 KB
Loading

‎docs/build/html/_modules/arraypartition/partition.html‎

Lines changed: 790 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build/html/_modules/index.html‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Overview: module code &mdash; ArrayPartition Package 1.0.1 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
8+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
9+
10+
11+
<link rel="shortcut icon" href="../_static/favicon.ico"/>
12+
<!--[if lt IE 9]>
13+
<script src="../_static/js/html5shiv.min.js"></script>
14+
<![endif]-->
15+
16+
<script src="../_static/jquery.js?v=5d32c60e"></script>
17+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=0b546569"></script>
19+
<script src="../_static/doctools.js?v=888ff710"></script>
20+
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
21+
<script src="../_static/js/theme.js"></script>
22+
<link rel="index" title="Index" href="../genindex.html" />
23+
<link rel="search" title="Search" href="../search.html" />
24+
</head>
25+
26+
<body class="wy-body-for-nav">
27+
<div class="wy-grid-for-nav">
28+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
29+
<div class="wy-side-scroll">
30+
<div class="wy-side-nav-search" >
31+
32+
33+
34+
<a href="../index.html" class="icon icon-home">
35+
ArrayPartition Package
36+
</a>
37+
<div role="search">
38+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
39+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
40+
<input type="hidden" name="check_keywords" value="yes" />
41+
<input type="hidden" name="area" value="default" />
42+
</form>
43+
</div>
44+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
45+
<!-- Local TOC -->
46+
<div class="local-toc"></div>
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
52+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
53+
<a href="../index.html">ArrayPartition Package</a>
54+
</nav>
55+
56+
<div class="wy-nav-content">
57+
<div class="rst-content">
58+
<div role="navigation" aria-label="Page navigation">
59+
<ul class="wy-breadcrumbs">
60+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
61+
<li class="breadcrumb-item active">Overview: module code</li>
62+
<li class="wy-breadcrumbs-aside">
63+
</li>
64+
</ul>
65+
<hr/>
66+
</div>
67+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
68+
<div itemprop="articleBody">
69+
70+
<h1>All modules for which code is available</h1>
71+
<ul><li><a href="arraypartition/partition.html">arraypartition.partition</a></li>
72+
</ul>
73+
74+
</div>
75+
</div>
76+
<footer>
77+
78+
<hr/>
79+
80+
<div role="contentinfo">
81+
<p>&#169; Copyright 2022-2024, Centre of Environmental Data Analysis Developers,Scientific and Technical Facilities Council (STFC),UK Research and Innovation (UKRI). BSD 2-Clause License. All rights reserved.</p>
82+
</div>
83+
84+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
85+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
86+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
87+
88+
89+
</footer>
90+
</div>
91+
</div>
92+
</section>
93+
</div>
94+
<script>
95+
jQuery(function () {
96+
SphinxRtdTheme.Navigation.enable(true);
97+
});
98+
</script>
99+
100+
</body>
101+
</html>

0 commit comments

Comments
 (0)