Skip to content

Commit 03b935d

Browse files
marcosfrenkelmarcosfrenkel
authored
initial structure. (#1)
* initial structure. * Updated upload-pages-artifact to v4 * Remove mambaforge in the miniforge-variant/ * Switching to conda now
1 parent 27b92f3 commit 03b935d

12 files changed

Lines changed: 258 additions & 1 deletion

File tree

‎.github/workflows/documentation.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
27+
- name: Set up Conda
28+
uses: conda-incubator/setup-miniconda@v3
29+
with:
30+
# miniforge-variant: Mambaforge
31+
# use-mamba: true
32+
environment-file: environment.yml
33+
34+
- name: Build documentation
35+
shell: bash -l {0}
36+
run: make html
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v4
40+
with:
41+
path: 'build/html'
42+
43+
deploy:
44+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
45+
needs: build
46+
runs-on: ubuntu-latest
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v2

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ cython_debug/
173173
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174174
# and can be added to the global gitignore or merged into this file. For a more nuclear
175175
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176-
#.idea/
176+
.idea/
177177

178178
# Abstra
179179
# Abstra is an AI-powered process automation framework.
@@ -205,3 +205,7 @@ cython_debug/
205205
marimo/_static/
206206
marimo/_lsp/
207207
__marimo__/
208+
209+
210+
# MacOs
211+
.DS_Store

‎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 = doc
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)

‎doc/_static/logo.png‎

141 KB
Loading

‎doc/conf.py‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'Tools for Experiments'
10+
copyright = '2026, Wolfgang Pfaff, Marcos Frenkel, Oliver Wolff'
11+
author = 'Wolfgang Pfaff, Marcos Frenkel, Oliver Wolff'
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = ['myst_parser']
17+
18+
templates_path = ['_templates']
19+
exclude_patterns = []
20+
21+
# -- Internationalization ----------------------------------------------------
22+
23+
# specifying the natural language populates some key tags
24+
language = "en"
25+
26+
27+
# -- Options for HTML output -------------------------------------------------
28+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
29+
30+
html_theme = "pydata_sphinx_theme"
31+
html_static_path = ['_static']
32+
html_logo = '_static/logo.png'
33+
34+
html_theme_options = {
35+
"logo": {
36+
"text": "Tools for Experiments",
37+
},
38+
"external_links": [
39+
{
40+
"url": "https://toolsforexperiments.github.io/labcore/",
41+
"name": "Labcore",
42+
},
43+
{
44+
"url": "https://toolsforexperiments.github.io/instrumentserver/",
45+
"name": "Instrumentserver",
46+
},
47+
{
48+
"url": "https://toolsforexperiments.github.io/plottr/",
49+
"name": "Plottr",
50+
},
51+
{
52+
"url": "https://toolsforexperiments.github.io/cqedtoolbox/",
53+
"name": "CQEDtoolbox",
54+
}
55+
56+
],
57+
"icon_links" : [
58+
{
59+
"name": "GitHub",
60+
"url": "https://github.com/toolsforexperiments",
61+
"icon": "fa-brands fa-github",
62+
}
63+
]
64+
}

‎doc/contributing/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing Guide
2+
3+
The following is a contributing Guide.
4+
5+
```{toctree}
6+
:caption: How do I contribute
7+
8+
setting_up
9+
```

‎doc/contributing/setting_up.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Setting Development Environment.
2+
3+
The following page is under construction.
4+
5+
## Git Usage
6+
7+
This organization uses git since we are in github
8+
9+
## Mypy
10+
11+
Type safety is ensured with mypy.
12+
13+
## Style consistency.
14+
15+
We will use Ruff to ensure style consistency

‎doc/examples/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Examples
2+
3+
Hello the following is a 15 minutes to TFE example guide.
4+
5+
This is under construction.
6+
7+
```{toctree}
8+
:caption: Get Started
9+
10+
intro
11+
qubit
12+
```

‎doc/examples/intro.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 15 Minutes to TFE
2+
3+
Hello welcome to the 15 minutes to TFE introduction guide.
4+
5+
This is under construction.

‎doc/examples/qubit.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# First Qubit Measurement
2+
3+
Hello this is a guide to how to perform a qubit measurement quickly. This page is under construction
4+
5+
## Setting up
6+
7+
This is the setting up page.
8+
9+
## Initialization
10+
11+
This is an initialization page.
12+
13+
## Measurement
14+
15+
This is a measurement section
16+
17+
### Measurement subsection 1
18+
19+
Subsection 1
20+
21+
### Measurement subsection 2
22+
23+
Subsection 2
24+
25+
## Analysis
26+
27+
Analyzing
28+
29+
### Plotting
30+
31+
Plotting
32+
33+
### Fitting
34+
35+
Fitting

0 commit comments

Comments
 (0)