Skip to content

Commit 6e0389a

Browse files
JamesPicoTechJamesPicoTech
authored
Updated docs (#147)
- Fixed titles in nav-bar - Updated dev sections: - Changelog - RoadMap - Current Support
1 parent 9fd4cac commit 6e0389a

34 files changed

+53
-52
lines changed

‎docs/docs/dev/changelog.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
22
# Changelog
3-
The changelog will be released upon the availability of an initial stable version.
3+
You can find a list of all changes in github tags in the link below:
4+
5+
<div style="text-align: center;">
6+
<a href="https://github.com/picotech/pyPicoSDK/releases"
7+
class="btn btn-neutral"
8+
title="Current Support">
9+
GitHub Releases <span class="icon icon-github"></span>
10+
</a>
11+
</div>
12+

‎docs/docs/dev/current.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
22
# Functions available pyPicoSDK v0.1
3-
## 6000 (A) API
4-
- Block Mode
5-
- Rapid Block Mode
6-
- Streaming Mode
3+
## 6000 (A) API (PicoScope 6000E Series)
4+
- Simple/Advanced Block Mode
5+
- Simple/Advanced Rapid Block Mode
76
- Signal Generator
7+
- All other direct driver functions
88

9-
## PSOSPA API
10-
- Block Mode
11-
- Rapid Block Mode
12-
- Streaming Mode
9+
## PSOSPA API (PicoScope 3000E Series)
10+
- Simple/Advanced Block Mode
11+
- Simple/Advanced Rapid Block Mode
1312
- Signal Generator
14-
15-
13+
- All other direct driver functions

‎docs/docs/dev/roadmap.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
22
# Roadmap for pyPicoSDK
33
## WIP
4-
- 6000 (A) API Signal Generator
5-
- Documentation
6-
- Complete docStrings for pypicoSDK
7-
- Adding constants docstrings
8-
- Extend ref introduction
9-
- Upload & test pypi (pip)
10-
- `setup.py` created, needs refining
11-
- Current in [test pypi](https://test.pypi.org/project/pypicosdk/)
4+
- Streaming examples (inc. downsampling)
125

13-
## To-Do
14-
- 6000 (A) streaming support
15-
- Add support for 3000 (A) drivers
16-
- Test & add support for macOS & linux
6+
## To-do:
7+
- PS2000 Driver support
8+
- PS2000(A) Driver support

‎docs/docs/ref/configuration.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# pyPicoSDK Configuration/Overrides
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
23

34
::: pypicosdk._config

‎docs/docs/ref/constants.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Constants/Enums
12
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
23
::: pypicosdk.constants
34
options:

‎docs/docs/ref/general.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
21
# General Functions
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
33

44
These functions are **not** scope specific, so will need to be called using
55
`psdk.[function]` or `pypicosdk.[function]` where `[function]` is one of the following:

‎docs/docs/ref/introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
21
# Introduction
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
33

44
Each picoSDK class is built from a common class (PicoScopeBase) and a specific sub-class (ps####a).
55
This allows each PicoScope to have shared, common functions such as opening the unit, while certain models have additional, hardware-specific functions.

‎docs/docs/ref/ps6000a/buffers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
21
# Memory / Buffer Management
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
33

44
::: pypicosdk.pypicosdk.ps6000a
55
options:

‎docs/docs/ref/ps6000a/captures.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
21
# Capture Configuration
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
33

44
::: pypicosdk.pypicosdk.ps6000a
55
options:

‎docs/docs/ref/ps6000a/channel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
21
# Channel Configuration
2+
<!-- Copyright (C) 2025-2025 Pico Technology Ltd. See LICENSE file for terms. -->
33

44
::: pypicosdk.pypicosdk.ps6000a
55
options:

0 commit comments

Comments
 (0)