Commit Graph
33 Commits
Author SHA1 Message Date
menzelandClaude Opus 4.8 ba27af5a71 docs(developer): add "How to edit these docs" contributor guide
CI for csaxs_bec / test (pull_request) Successful in 1m34s
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 3s
CI for csaxs_bec / test (push) Successful in 1m35s
Add docs/developer/editing_docs.md documenting the MyST/Sphinx conventions
for this site: page anatomy (cross-reference label + single H1), language-
tagged code fences, admonitions, cross-references, the {download} role for
non-image files, the {figure} directive, and how to add a page to a toctree.
Also covers local preview, the merge-then-RTD-build flow, and pitfalls
(broken refs are warnings, public visibility, placeholder consistency).

Turn the empty developer.md stub into a landing page with a toctree and a
card linking to the new guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-24 18:19:39 +02:00
menzelandClaude Opus 4.8 19aa25c7a7 docs(saxs): import data analysis guide from the documentation wiki
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 3s
CI for csaxs_bec / test (push) Successful in 1m34s
Migrate the SAXS data-analysis content into the RTD/Sphinx docs as
user/saxs/data_analysis.md, and turn the empty saxs.md stub into a
landing page linking to it.

Source: cSAXS documentation wiki, page "SAXS-data-analysis"
https://gitea.psi.ch/cSAXS/documentation/wiki/SAXS-data-analysis
(git@gitea.psi.ch:cSAXS/documentation.wiki.git, as of 408e535)

Converted Gitea-flavored Markdown to MyST: added cross-reference
labels, bash code fences, and {note} admonitions.

Also bundle the SAXS standards plate datasheet (SAXS_standards_plate.pdf),
previously at cSAXS/documentation/attachments/, linked via the MyST
{download} role so Sphinx copies it into the build.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-24 17:32:49 +02:00
holler fa799b1864 doku fix
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 2s
CI for csaxs_bec / test (push) Successful in 2m0s
2026-04-13 11:55:46 +02:00
holler 8265ad523c doku fix2
CI for csaxs_bec / test (pull_request) Successful in 2m2s
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 2s
CI for csaxs_bec / test (push) Has been cancelled
2026-04-13 11:52:52 +02:00
wakonig_k 0f0ec8e864 fix: restrict sphinx version to below 9 in requirements
CI for csaxs_bec / test (pull_request) Successful in 2m0s
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 2s
CI for csaxs_bec / test (push) Successful in 1m57s
2026-04-09 14:51:28 +02:00
holler d91c381aff update flomni docs with FZP distances
CI for csaxs_bec / test (pull_request) Successful in 1m58s
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 2s
CI for csaxs_bec / test (push) Successful in 1m59s
2026-04-09 14:39:08 +02:00
x12sa 43ae732e34 added check for optics in etc to only move if not already there
CI for csaxs_bec / test (pull_request) Successful in 1m59s
CI for csaxs_bec / test (push) Successful in 1m56s
2026-03-17 16:07:17 +01:00
x12sa 4967474271 removed fsh commands
CI for csaxs_bec / test (push) Successful in 1m57s
2026-03-17 14:48:05 +01:00
x12sa 58cd6bdaf7 fixes run 1
CI for csaxs_bec / test (push) Successful in 1m58s
2026-03-17 14:14:14 +01:00
x01dcandholler 70fa96bd58 added beck startup
CI for csaxs_bec / test (pull_request) Failing after 1m53s
CI for csaxs_bec / test (push) Failing after 1m55s
2026-03-06 14:39:34 +01:00
x12saandappel_c 6ed84664f2 added docs for burst acquisition 2026-03-02 13:15:53 +01:00
holler f8b20752f5 updated gui section
CI for csaxs_bec / test (push) Successful in 1m22s
2025-11-05 13:12:59 +01:00
Hollerandappel_c 66cd89ed63 flomni fixes 2025-09-12 15:43:38 +02:00
Holler Mirko cbb3f9e8bc added example table for temperatures 2025-01-08 13:22:19 +01:00
Holler Mirko 5f819d9835 further fix omny doc 2025-01-08 11:51:02 +01:00
Holler Mirko 8f55b6dbcb Fixes in omny documentation plus added show all for all relevant omny components 2025-01-08 11:46:49 +01:00
holler b2095f8d7b Merge branch 'main' into 'lamnidoc'
# Conflicts:
#   docs/user/ptychography/omny.md
2024-12-16 17:03:19 +01:00
Mirko Holler 9186853faf lamni doc 2024-12-16 16:50:53 +01:00
holler 4d241d26f3 Update omny.md values of interferometer SSI 2024-12-13 13:19:19 +01:00
holler 7ff2f7dc1b Update omny.md 2024-12-02 13:56:07 +01:00
holler ef1ab749a9 Update flomni.md 2024-12-02 13:56:07 +01:00
Mirko Holler ec53bb7000 fixes in flomni doc and completion of first version of omny doc 2024-12-02 13:44:18 +01:00
Mirko Holler 5f1449365d some mods omny doc 2024-11-29 17:28:28 +01:00
Mirko Holler 9699b39a7e continued with omny documentation 2024-11-29 13:20:39 +01:00
Mirko Holler 79f63b84fc completed initial version of flomni docs 2024-11-18 13:14:21 +01:00
Holler Mirko 5f9f2c8762 started editing flomni doc 2024-11-15 16:36:44 +01:00
Holler Mirko 58960944f8 init version 2024-11-15 15:37:41 +01:00
Holler Mirko dfb4fa75d9 initial version 2024-11-15 15:37:04 +01:00
wakonig_k 70b196403b docs: cleanup to support rtd autosummary 2024-11-14 17:43:05 +01:00
wakonig_k f14a5f220e docs: cleanup for rtd 2024-11-14 16:37:23 +01:00
wakonig_k b31a1ea996 docs: fixed api reference 2024-11-05 22:22:52 +01:00
wakonig_k 820b673144 docs: fixed landing page 2024-11-05 22:15:08 +01:00
wakonig_k 805d4b5a13 docs: add readthedocs configuration 2024-11-05 22:08:49 +01:00