Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
ba2d3e3
added intial docs
Jul 8, 2025
d0f74ec
untracked dir
Jul 8, 2025
ad84653
re-tracked
Jul 8, 2025
e445961
sphinx doc worflow
Jul 8, 2025
fe3a025
sphinx doc worflow
Jul 8, 2025
329ecd4
sphinx doc worflow
Jul 8, 2025
2c7328d
sphinx doc worflow
Jul 8, 2025
c64f83a
sphinx doc workflow
Jul 8, 2025
3dd121d
sphinx doc workflow
Jul 8, 2025
46db121
sphinx doc workflow re-added static path
Jul 8, 2025
77a0ed2
sphinx doc workflow changed deploy script
Jul 8, 2025
8ecb7c2
sphinx doc workflow changed deploy script
Jul 8, 2025
da0949e
sphinx doc workflow more deploy script changes
Jul 8, 2025
5c46d35
sphinx doc workflow more deploy script changes
Jul 8, 2025
b6dacb1
sphinx doc workflow more deploy script changes
Jul 8, 2025
19597e7
changed makefile to make api docs
Jul 8, 2025
c8c8da3
changed makefile to make api docs
Jul 8, 2025
f080e36
changed makefile to make api docs
Jul 8, 2025
86456a9
changed makefile to make api docs
Jul 8, 2025
dee66d0
changed the workflow to just use the built docs
Jul 8, 2025
d910391
updated git ignore
Jul 8, 2025
0eb93e9
gitignore changes
Jul 8, 2025
8ae5223
TOC change
Jul 9, 2025
b3de7f7
TOC change
Jul 9, 2025
0452fb6
TOC change
Jul 9, 2025
df5b124
TOC change
Jul 9, 2025
f8dadce
added warning
Jul 9, 2025
cf6a27b
added warning
Jul 9, 2025
573e97a
cool new theme
Jul 9, 2025
4d3199a
clean docs build
Jul 9, 2025
9ce0ccc
docs docs docs
Jul 10, 2025
d3001b0
source
Jul 10, 2025
86be269
docs work
Jul 14, 2025
e4ba9fe
more readable roadmap
Jul 14, 2025
b607aef
removed priority legend
Jul 14, 2025
2e7afad
finished readme for release
Jul 17, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Build & Deploy Sphinx Docs

on:
push:
branches: [20-documentation]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: 📥 Checkout code
uses: actions/checkout@v3

- name: 🐍 Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'

- name: 📦 Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx furo sphinx-autodoc-typehints

# - name: 🛠️ Build documentation # we are just using the uploaded ones
# run: |
# cd docs
# make html

- name: 📂 Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html/

deploy:
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ test.ipynb
image_model
test.h5
.vscode
build
/build
env.json
creds.json
test.py
Expand Down
30 changes: 30 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Minimal makefile for Sphinx documentation

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Adjust this to point to your Python package directory (relative to this Makefile)
APIDOCSRC = ../poly_lithic
APIDOCOUT = $(SOURCEDIR)/api

.PHONY: help Makefile apidoc

# Default target: "make" is like "make help"
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# Autogenerate .rst files from Python source using sphinx-apidoc
apidoc:
sphinx-apidoc -o $(APIDOCOUT) $(APIDOCSRC) --force --no-toc --separate

# Build HTML docs, running apidoc first
html: apidoc
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# Catch-all target: route all unknown targets to Sphinx
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added docs/build/doctrees/api/poly_lithic.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/build/doctrees/api/poly_lithic.src.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/build/doctrees/config.doctree
Binary file not shown.
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/build/doctrees/interfaces.doctree
Binary file not shown.
Binary file added docs/build/doctrees/transformers.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f3fa5c90ff625fc0342352252d74e923
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 97716ac4656efbec94163cb968cb166f
tags: 645f666f9bcd5a90fca523b33c5a78b7
191 changes: 191 additions & 0 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
<!DOCTYPE html>
<html lang="en"
data-content_root="../"
x-data="{ darkMode: localStorage.getItem('darkMode') || localStorage.setItem('darkMode', 'system'), activeSection: '' }"
x-init="$watch('darkMode', val => localStorage.setItem('darkMode', val))"
class="scroll-smooth"
:class="{'dark': darkMode === 'dark' || (darkMode === 'system' && window.matchMedia('(prefers-color-scheme: dark)').matches)}"
>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta charset="utf-8" />
<meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />

<title>Overview: module code | Poly-Lithic documentation</title>
<meta property="og:title" content="Overview: module code | Poly-Lithic documentation" />
<meta name="twitter:title" content="Overview: module code | Poly-Lithic documentation" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=e72c8e07" />
<link rel="stylesheet" type="text/css" href="../_static/theme.css?v=42baaae4" />
<link rel="search" title="Search" href="../search.html" />
<link rel="index" title="Index" href="../genindex.html" />

<script>
<!-- Prevent Flash of wrong theme -->
const userPreference = localStorage.getItem('darkMode');
let mode;
if (userPreference === 'dark' || window.matchMedia('(prefers-color-scheme: dark)').matches) {
mode = 'dark';
document.documentElement.classList.add('dark');
} else {
mode = 'light';
}
if (!userPreference) {localStorage.setItem('darkMode', mode)}
</script>
</head>
<body x-data="{ showSidebar: false, showScrollTop: false }" class="min-h-screen font-sans antialiased bg-background text-foreground" :class="{ 'overflow-hidden': showSidebar }">
<div x-cloak x-show="showSidebar" class="fixed inset-0 z-50 overflow-hidden bg-background/80 backdrop-blur-sm md:hidden" @click.self="showSidebar = false"></div><div id="page" class="relative flex flex-col min-h-screen"><a href="#content" class="absolute top-0 left-0 z-[100] block bg-background p-4 text-xl transition -translate-x-full opacity-0 focus:translate-x-0 focus:opacity-100">
Skip to content
</a><header
class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
<div class="hidden mr-4 md:flex">
<a href="../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">Poly-Lithic documentation</span>
</a></div><button
class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
type="button" @click="showSidebar = true">
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" aria-hidden="true"
fill="currentColor">
<path
d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z" />
</svg>
<span class="sr-only">Toggle navigation menu</span>
</button>
<div class="flex items-center justify-between flex-1 space-x-2 sm:space-x-4 md:justify-end">
<div class="flex-1 w-full md:w-auto md:flex-none"><form id="searchbox"
action="../search.html"
method="get"
class="relative flex items-center group"
@keydown.k.window.meta="$refs.search.focus()">
<input x-ref="search"
name="q"
id="search-input"
type="search"
aria-label="Search the docs"
placeholder="Search ..."
class="inline-flex items-center font-medium transition-colors bg-transparent focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 ring-offset-background border border-input hover:bg-accent focus:bg-accent hover:text-accent-foreground focus:text-accent-foreground hover:placeholder-accent-foreground py-2 px-4 relative h-9 w-full justify-start rounded-[0.5rem] text-sm text-muted-foreground sm:pr-12 md:w-40 lg:w-64" />
<kbd class="pointer-events-none absolute right-1.5 top-2 hidden h-5 select-none text-muted-foreground items-center gap-1 rounded border border-border bg-muted px-1.5 font-mono text-[10px] font-medium opacity-100 sm:flex group-hover:bg-accent group-hover:text-accent-foreground">
<span class="text-xs">⌘</span>
K
</kbd>
</form>
</div>
<nav class="flex items-center space-x-1">
<button @click="darkMode = darkMode === 'light' ? 'dark' : 'light'"
class="relative inline-flex items-center justify-center px-0 text-sm font-medium transition-colors rounded-md hover:bg-accent hover:text-accent-foreground h-9 w-9"
type="button"
aria-label="Color theme switcher">
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
class="absolute transition-all scale-100 rotate-0 dark:-rotate-90 dark:scale-0">
<path
d="M480 685q45.456 0 77.228-31.772Q589 621.456 589 576q0-45.456-31.772-77.228Q525.456 467 480 467q-45.456 0-77.228 31.772Q371 530.544 371 576q0 45.456 31.772 77.228Q434.544 685 480 685Zm0 91q-83 0-141.5-58.5T280 576q0-83 58.5-141.5T480 376q83 0 141.5 58.5T680 576q0 83-58.5 141.5T480 776ZM80 621.5q-19.152 0-32.326-13.174T34.5 576q0-19.152 13.174-32.326T80 530.5h80q19.152 0 32.326 13.174T205.5 576q0 19.152-13.174 32.326T160 621.5H80Zm720 0q-19.152 0-32.326-13.174T754.5 576q0-19.152 13.174-32.326T800 530.5h80q19.152 0 32.326 13.174T925.5 576q0 19.152-13.174 32.326T880 621.5h-80Zm-320-320q-19.152 0-32.326-13.174T434.5 256v-80q0-19.152 13.174-32.326T480 130.5q19.152 0 32.326 13.174T525.5 176v80q0 19.152-13.174 32.326T480 301.5Zm0 720q-19.152 0-32.326-13.17Q434.5 995.152 434.5 976v-80q0-19.152 13.174-32.326T480 850.5q19.152 0 32.326 13.174T525.5 896v80q0 19.152-13.174 32.33-13.174 13.17-32.326 13.17ZM222.174 382.065l-43-42Q165.5 327.391 166 308.239t13.174-33.065q13.435-13.674 32.587-13.674t32.065 13.674l42.239 43q12.674 13.435 12.555 31.706-.12 18.272-12.555 31.946-12.674 13.674-31.445 13.413-18.772-.261-32.446-13.174Zm494 494.761-42.239-43q-12.674-13.435-12.674-32.087t12.674-31.565Q686.609 756.5 705.38 757q18.772.5 32.446 13.174l43 41.761Q794.5 824.609 794 843.761t-13.174 33.065Q767.391 890.5 748.239 890.5t-32.065-13.674Zm-42-494.761Q660.5 369.391 661 350.62q.5-18.772 13.174-32.446l41.761-43Q728.609 261.5 747.761 262t33.065 13.174q13.674 13.435 13.674 32.587t-13.674 32.065l-43 42.239q-13.435 12.674-31.706 12.555-18.272-.12-31.946-12.555Zm-495 494.761Q165.5 863.391 165.5 844.239t13.674-32.065l43-42.239q13.435-12.674 32.087-12.674t31.565 12.674Q299.5 782.609 299 801.38q-.5 18.772-13.174 32.446l-41.761 43Q231.391 890.5 212.239 890t-33.065-13.174ZM480 576Z" />
</svg>
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
class="absolute transition-all scale-0 rotate-90 dark:rotate-0 dark:scale-100">
<path
d="M480 936q-151 0-255.5-104.5T120 576q0-138 90-239.5T440 218q25-3 39 18t-1 44q-17 26-25.5 55t-8.5 61q0 90 63 153t153 63q31 0 61.5-9t54.5-25q21-14 43-1.5t19 39.5q-14 138-117.5 229T480 936Zm0-80q88 0 158-48.5T740 681q-20 5-40 8t-40 3q-123 0-209.5-86.5T364 396q0-20 3-40t8-40q-78 32-126.5 102T200 576q0 116 82 198t198 82Zm-10-270Z" />
</svg>
</button>
</nav>
</div>
</div>
</header>

<div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside id="left-sidebar"
class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
:aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">

<a href="../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">Poly-Lithic documentation</span>
</a>

<div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
<div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
<p class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../transformers.html">Transformers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interfaces.html">Interfaces Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../config.html">Configuration Guide</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/poly_lithic.src.html">poly_lithic.src package</a></li>
</ul>

</nav>
</div>
</div>
<button type="button" @click="showSidebar = false"
class="absolute md:hidden right-4 top-4 rounded-sm opacity-70 transition-opacity hover:opacity-100">
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 96 960 960" fill="currentColor"
stroke="none" class="h-4 w-4">
<path
d="M480 632 284 828q-11 11-28 11t-28-11q-11-11-11-28t11-28l196-196-196-196q-11-11-11-28t11-28q11-11 28-11t28 11l196 196 196-196q11-11 28-11t28 11q11 11 11 28t-11 28L536 576l196 196q11 11 11 28t-11 28q-11 11-28 11t-28-11L480 632Z" />
</svg>
</button>
</aside>
<main class="relative py-6 lg:gap-10 lg:py-8 xl:grid xl:grid-cols-[1fr_300px]">
<div class="w-full min-w-0 mx-auto">
<nav aria-label="breadcrumbs"
class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
<a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
href="../index.html">
<span class="hidden md:inline">Poly-Lithic documentation</span>
<svg xmlns="http://www.w3.org/2000/svg"
height="18"
width="18"
viewBox="0 96 960 960"
aria-label="Home"
fill="currentColor"
stroke="none"
class="md:hidden">
<path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z" />
</svg>
</a>

<div class="mr-1">/</div><span aria-current="page"
class="font-medium text-foreground overflow-hidden text-ellipsis whitespace-nowrap">Overview: module code</span>
</nav>

<div id="content" role="main">
<h1>All modules for which code is available</h1>
<ul><li><a href="poly_lithic/scripts/main.html">poly_lithic.scripts.main</a></li>
<li><a href="poly_lithic/src/cli.html">poly_lithic.src.cli</a></li>
<li><a href="poly_lithic/src/config/config_object.html">poly_lithic.src.config.config_object</a></li>
<li><a href="poly_lithic/src/config/parser.html">poly_lithic.src.config.parser</a></li>
<li><a href="poly_lithic/src/interfaces.html">poly_lithic.src.interfaces</a></li>
<ul><li><a href="poly_lithic/src/interfaces/BaseInterface.html">poly_lithic.src.interfaces.BaseInterface</a></li>
<li><a href="poly_lithic/src/interfaces/file_interface.html">poly_lithic.src.interfaces.file_interface</a></li>
<li><a href="poly_lithic/src/interfaces/k2eg_interface.html">poly_lithic.src.interfaces.k2eg_interface</a></li>
<li><a href="poly_lithic/src/interfaces/p4p_interface.html">poly_lithic.src.interfaces.p4p_interface</a></li>
</ul><li><a href="poly_lithic/src/logging_utils/make_logger.html">poly_lithic.src.logging_utils.make_logger</a></li>
<li><a href="poly_lithic/src/model_utils/LocalModelGetter.html">poly_lithic.src.model_utils.LocalModelGetter</a></li>
<li><a href="poly_lithic/src/model_utils/MlflowModelGetter.html">poly_lithic.src.model_utils.MlflowModelGetter</a></li>
<li><a href="poly_lithic/src/model_utils/ModelGetterBase.html">poly_lithic.src.model_utils.ModelGetterBase</a></li>
<li><a href="poly_lithic/src/transformers.html">poly_lithic.src.transformers</a></li>
<ul><li><a href="poly_lithic/src/transformers/BaseTransformer.html">poly_lithic.src.transformers.BaseTransformer</a></li>
<li><a href="poly_lithic/src/transformers/BaseTransformers.html">poly_lithic.src.transformers.BaseTransformers</a></li>
<li><a href="poly_lithic/src/transformers/CompoundTransformer.html">poly_lithic.src.transformers.CompoundTransformer</a></li>
</ul><li><a href="poly_lithic/src/utils/builder.html">poly_lithic.src.utils.builder</a></li>
<li><a href="poly_lithic/src/utils/lazyInterfaceLoader.html">poly_lithic.src.utils.lazyInterfaceLoader</a></li>
<li><a href="poly_lithic/src/utils/messaging.html">poly_lithic.src.utils.messaging</a></li>
</ul>
</div></div>
</main>
</div>
</div><footer class="py-6 border-t border-border md:py-0">
<div class="container flex flex-col items-center justify-between gap-4 md:h-24 md:flex-row">
<div class="flex flex-col items-center gap-4 px-8 md:flex-row md:gap-2 md:px-0">
<p class="text-sm leading-loose text-center text-muted-foreground md:text-left">© 2025, Matuesz Leputa - ISIS Neutron and Muon Source at RAL - Science and Technology Facilities Council&nbsp;Built with <a class="font-medium underline underline-offset-4"
href="https://www.sphinx-doc.org"
rel="noreferrer">Sphinx 8.2.3</a></p>
</div>
</div>
</footer>
</div>

<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="defer" src="../_static/theme.js?v=073f68d9"></script>

</body>
</html>
Loading