Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 967 Bytes

File metadata and controls

34 lines (23 loc) · 967 Bytes

nilrt-docs

Official documentation for the NI Linux Real-Time OS.

The built documentation is hosted at https://nilrt-docs.ni.com/.

Building

This documentation is built using Sphinx. To build:

  1. Install the host build tools.

  2. Install the python requirements specified in :requirements.txt. It is recommended that you use a python virtual environment.

    python3 -m venv .venv
    source .venv/bin/activate
    pip install --upgrade pip
    pip install -r requirements.txt
  3. Build the project using the included Makefile.

    make all

    The built documentation output will appear under :docs/build/html/.

About NI Linux Real-Time

To learn about NI Linux Real-Time, visit the NI Linux Real-Time Portal.