Documentation reorganisation

Just about everything about Red Pitaya
Post Reply
User avatar
redpitaya
Site Admin
Posts: 912
Joined: Wed Mar 26, 2014 7:04 pm

Documentation reorganisation

Post by redpitaya » Wed Jan 10, 2024 3:26 pm

First of all, we wish you a Happy New Year!

Some of you might have noticed that a lot of links on some previous posts are not working anymore. We reordered the documentation to make it more intuitive: some topics were shifted a level up or down, which resulted in broken links.

In short, here are all the major changes to the documentation:
- Code examples and command tables were moved one level up to be visible directly from the Remote control menu (previously, they were buried under the SCPI server, which was counter-intuitive, as the C and Python API commands and examples are in the same section)
- Jupyter examples were restructured to include a link to the Red Pitaya Jupyter GitHub repository (and not have a link to each specific example). After the OS update next week, the Jupyter example links will also be included under specific examples in the Example section.

We hope that you can understand the reason for this change. Even though most previous links do not function anymore, we hope a better documentation structure can make up for this.

Please note that all the examples and commands are updated to reflect the latest OS. If a specific command is not working for you, please check the Ecosystem version column in the Command List.

We are planning to make a special "Known issues page", where we will report the non-working SCPI commands and changes (per Red Pitaya OS version) in the documentation.

Here are the new links:
- Remote control/programming: https://redpitaya.readthedocs.io/en/lat ... trol-tools
- Command table (SCPI, C&Python API, JupyterLab commands): https://redpitaya.readthedocs.io/en/lat ... i-commands
- Code examples: https://redpitaya.readthedocs.io/en/lat ... l#examples
- Jupyter GitHub (temporary): https://github.com/RedPitaya/jupyter/tr ... 2.x_rp_api
- Jupyter GitHub (permanent) (not yet updated): https://github.com/RedPitaya/jupyter/tree/master

Good luck with your projects!

Post Reply
jadalnie klasyczne ekskluzywne meble wypoczynkowe do salonu ekskluzywne meble tapicerowane ekskluzywne meble do sypialni ekskluzywne meble włoskie

Who is online

Users browsing this forum: No registered users and 96 guests