Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/github_actions_aws_rhel_python64.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ jobs:
- nidmm
- nifgen
- nimodinst
- nirfsa
- nirfsg
- niscope
- niswitch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ jobs:
- nifgen
- nidcpower
- nidmm
- nirfsa
- nirfsg
- niscope
- nimodinst
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ jobs:
- nifgen
- nidcpower
- nidmm
- nirfsa
- nirfsg
- niscope
- nimodinst
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# In alphabetical order except put nifake first and nimodinst/nitclk last
# - nifake first to get the most code generator coverage
# - nimodinst last so that the version from nimodinst is used for any global versions (docs/conf.py)
ALL_DRIVERS := nifake nidcpower nidigital nidmm nifgen nirfsg niscope niswitch nise nimodinst nitclk
ALL_DRIVERS := nifake nidcpower nidigital nidmm nifgen nirfsa nirfsg niscope niswitch nise nimodinst nitclk
DRIVERS ?= $(ALL_DRIVERS)

ROOT_DIR := $(abspath .)
Expand Down
46 changes: 46 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,52 @@ NI-ModInst Python API Status



NI-RFSA Python API Status
-------------------------

+-------------------------------+-----------------------+
| NI-RFSA (nirfsa) | |
+===============================+=======================+
| Driver Version Tested Against | 2026 Q3 |
+-------------------------------+-----------------------+
| PyPI Version | |nirfsaLatestVersion| |
+-------------------------------+-----------------------+
| Supported Python Version | |nirfsaPythonVersion| |
+-------------------------------+-----------------------+
| Documentation | |nirfsaDocs| |
+-------------------------------+-----------------------+
| Open Issues | |nirfsaOpenIssues| |
+-------------------------------+-----------------------+
| Open Pull Requests | |nirfsaOpenPRs| |
+-------------------------------+-----------------------+


.. |nirfsaLatestVersion| image:: http://img.shields.io/pypi/v/nirfsa.svg
:alt: Latest NI-RFSA Version
:target: http://pypi.python.org/pypi/nirfsa


.. |nirfsaPythonVersion| image:: http://img.shields.io/pypi/pyversions/nirfsa.svg
:alt: NI-RFSA supported Python versions
:target: http://pypi.python.org/pypi/nirfsa


.. |nirfsaDocs| image:: https://readthedocs.org/projects/nirfsa/badge/?version=latest
:alt: NI-RFSA Python API Documentation Status
:target: https://nirfsa.readthedocs.io/en/latest


.. |nirfsaOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nirfsa.svg
:alt: Open Issues + Pull Requests for NI-RFSA
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anirfsa


.. |nirfsaOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nirfsa.svg
:alt: Pull Requests for NI-RFSA
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anirfsa



NI-RFSG Python API Status
-------------------------

Expand Down
51 changes: 51 additions & 0 deletions docs/nirfsa/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Why Use A Configuration File?
# https://docs.readthedocs.io/en/stable/config-file/index.html
# The main advantages of using a configuration file over the web interface are:
# * Settings are per version rather than per project.
# * Settings live in your VCS.
# * They enable reproducible build environments over time.
# * Some settings are only available using a configuration file

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
# pre_build:
# # Check for broken external links
# - python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/ _build/linkcheck
post_checkout:
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
# Build-cancellation rules are recommended for monorepos.
# Cancel building pull requests when there aren't changes in any of these paths: docs/_static/ docs/nirfsa/.
#
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/master -- docs/_static/ docs/nirfsa/;
then
exit 183;
fi

# Have Read the Docs build documentation with Sphinx
sphinx:
builder: html
configuration: docs/nirfsa/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- epub
- pdf

# Declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
15 changes: 15 additions & 0 deletions docs/nirfsa/about_nirfsa.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _about-section:

About
=====

The **nirfsa** module provides a Python API for NI-RFSA. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.

Support Policy
--------------
**nirfsa** supports all the Operating Systems supported by NI-RFSA.

It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.

NI created and supports **nirfsa**.

Loading
Loading