From 05b3e7798881e15bce397d790b61297432dfa716 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Wed, 10 May 2023 11:29:04 -0500 Subject: [PATCH 01/31] generate individual conf.py files --- Makefile | 1 + build/Makefile | 6 -- build/defines.mak | 1 + build/rules.mak | 18 +++- build/templates/conf.py.mako | 23 +++-- build/tools.mak | 2 + docs/nidcpower/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/nidigital/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/{ => nidmm}/conf.py | 14 +-- docs/nifgen/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/nimodinst/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/niscope/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/nise/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/niswitch/conf.py | 189 +++++++++++++++++++++++++++++++++++ docs/nitclk/conf.py | 189 +++++++++++++++++++++++++++++++++++ src/nidcpower/nidcpower.mak | 2 + src/nidigital/nidigital.mak | 2 + src/nidmm/nidmm.mak | 2 + src/nifake/nifake.mak | 1 + src/nifgen/nifgen.mak | 2 + src/nimodinst/nimodinst.mak | 2 + src/niscope/niscope.mak | 2 + src/nise/nise.mak | 2 + src/niswitch/niswitch.mak | 1 + src/nitclk/nitclk.mak | 2 + 25 files changed, 1570 insertions(+), 25 deletions(-) create mode 100644 docs/nidcpower/conf.py create mode 100644 docs/nidigital/conf.py rename docs/{ => nidmm}/conf.py (90%) create mode 100644 docs/nifgen/conf.py create mode 100644 docs/nimodinst/conf.py create mode 100644 docs/niscope/conf.py create mode 100644 docs/nise/conf.py create mode 100644 docs/niswitch/conf.py create mode 100644 docs/nitclk/conf.py diff --git a/Makefile b/Makefile index ea6fe2f2c1..0693e8bb85 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,7 @@ # - 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 niscope niswitch nise nimodinst nitclk +DRIVERS_WITH_DOCS := nidcpower nidigital nidmm nifgen niscope niswitch nise nimodinst nitclk DRIVERS ?= $(ALL_DRIVERS) ROOT_DIR := $(abspath .) diff --git a/build/Makefile b/build/Makefile index e414d4001f..61a5a25fda 100644 --- a/build/Makefile +++ b/build/Makefile @@ -24,7 +24,6 @@ ifeq (,$(MAKECMDGOALS)) ROOT_FILES := \ $(ROOT_DIR)/README.rst \ $(ROOT_DIR)/VERSION \ - $(DOCS_DIR)/conf.py \ endif @@ -153,11 +152,6 @@ $(ROOT_DIR)/VERSION: $(GLOBAL_FILES_STARTED_FILE) $(call trace_to_console, "Creating Root",$(notdir $@)) tools/update_version_file.py $(_hide_cmds)$(call global_log_command,$(PYTHON_CMD) tools/update_version_file.py --output-file $@ $(foreach d,$(DRIVERS),--input-file $(GENERATED_DIR)/$(d)/$(d)/VERSION )) -$(DOCS_DIR)/conf.py: build/templates/conf.py.mako $(ROOT_DIR)/VERSION tools/simple_mako.py $(GLOBAL_FILES_STARTED_FILE) - $(call trace_to_console, "Creating Root",$(notdir $@)) - $(_hide_cmds)$(call global_log_command,$(PYTHON_CMD) tools/simple_mako.py --output-file $@ --template $<) - - # Any step that any driver build does that would invalidate unit testing, flake8 or generated html # needs to delete this file. This will trigger a tox run. TOX_RUN_DONE := $(GENERATED_DIR)/tox_run_done diff --git a/build/defines.mak b/build/defines.mak index 560dd7d251..04a85d6158 100644 --- a/build/defines.mak +++ b/build/defines.mak @@ -87,6 +87,7 @@ DEFAULT_RST_FILES_TO_GENERATE := \ grpc_session_options.rst \ ) \ +DEFAULT_SPHINX_CONF_PY := $(DRIVER_DOCS_DIR)/conf.py # Files for tracking parts of the build SDIST_WHEEL_BUILD_DONE := $(LOG_DIR)/sdist_wheel_build_done diff --git a/build/rules.mak b/build/rules.mak index 8dc7e86162..992e04a94f 100644 --- a/build/rules.mak +++ b/build/rules.mak @@ -30,8 +30,6 @@ endif # ifneq (,$(EXAMPLE_FILES)) MKDIR: $(MKDIRECTORIES) -CURRENT_DIR := $(shell pwd) - define mkdir_rule $1: $(call trace_to_console, "Making dir",$1) @@ -86,6 +84,10 @@ $(DRIVER_DOCS_DIR)/%.inc: %.inc.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) $(call trace_to_console, "Generating",$@) $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) +$(SPHINX_CONF_PY): $(TEMPLATE_DIR)/conf.py.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) + $(call trace_to_console, "Generating",$@) + $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) + $(DRIVER_EXAMPLES_ZIP_FILE): $(EXAMPLE_FILES) $(call trace_to_console, "Zipping",$@) $(_hide_cmds)$(call log_command,cd src/$(DRIVER)/examples && zip -u -r -9 $@ * || ([ $$? -eq 12 ] && exit 0) || exit) @@ -101,7 +103,7 @@ clean: .PHONY: module doc_files sdist wheel installers module: $(MODULE_FILES) $(UNIT_TEST_FILES) -doc_files: $(RST_FILES) +doc_files: $(RST_FILES) $(SPHINX_CONF_PY) installers: sdist wheel $(UNIT_TEST_FILES): $(MODULE_FILES) @@ -131,7 +133,15 @@ else # We piece together the readme files instead of relying on the rst include directive because we need these files to be standalone and not require any additional files that are in specific locations. $(README): $(RST_FILES) $(wildcard $(STATIC_DOCS_DIR)/*) $(call trace_to_console, "Creating",$@) - $(_hide_cmds)$(call log_command,cat $(STATIC_DOCS_DIR)/status_project.inc $(STATIC_DOCS_DIR)/about.inc $(DRIVER_DOCS_DIR)/status.inc $(DRIVER_DOCS_DIR)/installation.inc $(STATIC_DOCS_DIR)/contributing.inc $(STATIC_DOCS_DIR)/$(DRIVER)_usage.inc $(STATIC_DOCS_DIR)/support.inc $(STATIC_DOCS_DIR)/documentation.inc $(STATIC_DOCS_DIR)/license.inc > $@) + $(_hide_cmds)$(call log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \ + $(STATIC_DOCS_DIR)/about.inc \ + $(DRIVER_DOCS_DIR)/status.inc \ + $(DRIVER_DOCS_DIR)/installation.inc \ + $(STATIC_DOCS_DIR)/contributing.inc \ + $(STATIC_DOCS_DIR)/$(DRIVER)_usage.inc \ + $(STATIC_DOCS_DIR)/support.inc \ + $(STATIC_DOCS_DIR)/documentation.inc \ + $(STATIC_DOCS_DIR)/license.inc > $@) endif diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index fa5ee982eb..b22db0dccf 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -2,14 +2,17 @@ import datetime current_year = datetime.datetime.today().year -with open('./VERSION') as vf: - global_version = vf.read().strip() +config = template_parameters['metadata'].config +version = config['module_version'] +api_name = f"{config['driver_name']} Python API" +api_name_no_spaces_or_hyphens = api_name.replace(" ", "").replace("-", "") +api_name_no_spaces_or_hyphens_lower = api_name_no_spaces_or_hyphens.lower() %>\ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# NI Modular Instruments Python API documentation build configuration file, created by +# ${api_name} documentation build configuration file, created by # sphinx-quickstart on Fri Jul 14 13:04:36 2017. # # This file is execfile()d with the current directory set to its @@ -62,7 +65,9 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'NI Modular Instruments Python API' +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = '${api_name}' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-${current_year}, National Instruments Corporation' author = 'NI' @@ -71,7 +76,7 @@ author = 'NI' # built documents. # # The full version, including alpha/beta/rc tags. -release = '${global_version}' +release = '${version}' # The short X.Y version. version = release[:3] @@ -164,7 +169,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'NIModularInstrumentsPythonAPI.tex', 'NI Modular Instruments Python API Documentation', + (master_doc, '${api_name_no_spaces_or_hyphens}.tex', '${api_name} Documentation', 'NI', 'manual'), ] @@ -174,7 +179,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'nimodularinstrumentspythonapi', 'NI Modular Instruments Python API Documentation', + (master_doc, '${api_name_no_spaces_or_hyphens_lower}', '${api_name} Documentation', [author], 1) ] @@ -185,8 +190,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'NIModularInstrumentsPythonAPI', 'NI Modular Instruments Python API Documentation', - author, 'NIModularInstrumentsPythonAPI', 'One line description of project.', + (master_doc, '${api_name_no_spaces_or_hyphens}', '${api_name} Documentation', + author, '${api_name_no_spaces_or_hyphens}', 'One line description of project.', 'Miscellaneous'), ] diff --git a/build/tools.mak b/build/tools.mak index a4afeecf11..8471717a4f 100644 --- a/build/tools.mak +++ b/build/tools.mak @@ -1,5 +1,7 @@ # Useful functions +CURRENT_DIR := $(shell pwd) + # Traces to console, nicely formatted. # $1 is the Action, for example: "Generating" # $2 is a Path. diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py new file mode 100644 index 0000000000..2f04342f67 --- /dev/null +++ b/docs/nidcpower/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-DCPower Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-DCPower Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NIDCPowerPythonAPI.tex', 'NI-DCPower Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nidcpowerpythonapi', 'NI-DCPower Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NIDCPowerPythonAPI', 'NI-DCPower Python API Documentation', + author, 'NIDCPowerPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py new file mode 100644 index 0000000000..f661ed81eb --- /dev/null +++ b/docs/nidigital/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-Digital Pattern Driver Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-Digital Pattern Driver Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NIDigitalPatternDriverPythonAPI.tex', 'NI-Digital Pattern Driver Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nidigitalpatterndriverpythonapi', 'NI-Digital Pattern Driver Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NIDigitalPatternDriverPythonAPI', 'NI-Digital Pattern Driver Python API Documentation', + author, 'NIDigitalPatternDriverPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/conf.py b/docs/nidmm/conf.py similarity index 90% rename from docs/conf.py rename to docs/nidmm/conf.py index 59f48b4a25..7f41a2ed85 100644 --- a/docs/conf.py +++ b/docs/nidmm/conf.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# NI Modular Instruments Python API documentation build configuration file, created by +# NI-DMM Python API documentation build configuration file, created by # sphinx-quickstart on Fri Jul 14 13:04:36 2017. # # This file is execfile()d with the current directory set to its @@ -54,7 +54,9 @@ master_doc = 'index' # General information about the project. -project = 'NI Modular Instruments Python API' +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-DMM Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' @@ -156,7 +158,7 @@ def setup(app): # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'NIModularInstrumentsPythonAPI.tex', 'NI Modular Instruments Python API Documentation', + (master_doc, 'NIDMMPythonAPI.tex', 'NI-DMM Python API Documentation', 'NI', 'manual'), ] @@ -166,7 +168,7 @@ def setup(app): # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'nimodularinstrumentspythonapi', 'NI Modular Instruments Python API Documentation', + (master_doc, 'nidmmpythonapi', 'NI-DMM Python API Documentation', [author], 1) ] @@ -177,8 +179,8 @@ def setup(app): # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'NIModularInstrumentsPythonAPI', 'NI Modular Instruments Python API Documentation', - author, 'NIModularInstrumentsPythonAPI', 'One line description of project.', + (master_doc, 'NIDMMPythonAPI', 'NI-DMM Python API Documentation', + author, 'NIDMMPythonAPI', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py new file mode 100644 index 0000000000..5b8c8188c0 --- /dev/null +++ b/docs/nifgen/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-FGEN Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-FGEN Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NIFGENPythonAPI.tex', 'NI-FGEN Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nifgenpythonapi', 'NI-FGEN Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NIFGENPythonAPI', 'NI-FGEN Python API Documentation', + author, 'NIFGENPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py new file mode 100644 index 0000000000..8ed1f5ff15 --- /dev/null +++ b/docs/nimodinst/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-ModInst Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-ModInst Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NIModInstPythonAPI.tex', 'NI-ModInst Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nimodinstpythonapi', 'NI-ModInst Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NIModInstPythonAPI', 'NI-ModInst Python API Documentation', + author, 'NIModInstPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py new file mode 100644 index 0000000000..34acb788d2 --- /dev/null +++ b/docs/niscope/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-SCOPE Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-SCOPE Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NISCOPEPythonAPI.tex', 'NI-SCOPE Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'niscopepythonapi', 'NI-SCOPE Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NISCOPEPythonAPI', 'NI-SCOPE Python API Documentation', + author, 'NISCOPEPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/nise/conf.py b/docs/nise/conf.py new file mode 100644 index 0000000000..0432893924 --- /dev/null +++ b/docs/nise/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI Switch Executive Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI Switch Executive Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NISwitchExecutivePythonAPI.tex', 'NI Switch Executive Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'niswitchexecutivepythonapi', 'NI Switch Executive Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NISwitchExecutivePythonAPI', 'NI Switch Executive Python API Documentation', + author, 'NISwitchExecutivePythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py new file mode 100644 index 0000000000..133f6a75ad --- /dev/null +++ b/docs/niswitch/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-SWITCH Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-SWITCH Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NISWITCHPythonAPI.tex', 'NI-SWITCH Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'niswitchpythonapi', 'NI-SWITCH Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NISWITCHPythonAPI', 'NI-SWITCH Python API Documentation', + author, 'NISWITCHPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py new file mode 100644 index 0000000000..9ddcd0c346 --- /dev/null +++ b/docs/nitclk/conf.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI-TClk Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +# TODO(ni-jfitzger): Should we leave the project name unchanged? +project = 'NI-TClk Python API' +# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NITClkPythonAPI.tex', 'NI-TClk Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nitclkpythonapi', 'NI-TClk Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NITClkPythonAPI', 'NI-TClk Python API Documentation', + author, 'NITClkPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + diff --git a/src/nidcpower/nidcpower.mak b/src/nidcpower/nidcpower.mak index 36bad79903..bc7a1b0dd8 100644 --- a/src/nidcpower/nidcpower.mak +++ b/src/nidcpower/nidcpower.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + CUSTOM_TYPES_TO_COPY += \ lcr_load_compensation_spot.py \ lcr_measurement.py \ diff --git a/src/nidigital/nidigital.mak b/src/nidigital/nidigital.mak index 74034f3cfd..1479b86590 100644 --- a/src/nidigital/nidigital.mak +++ b/src/nidigital/nidigital.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + CUSTOM_TYPES_TO_COPY += \ history_ram_cycle_information.py \ diff --git a/src/nidmm/nidmm.mak b/src/nidmm/nidmm.mak index 9ad990b157..72775b4eb5 100644 --- a/src/nidmm/nidmm.mak +++ b/src/nidmm/nidmm.mak @@ -8,5 +8,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nifake/nifake.mak b/src/nifake/nifake.mak index f53d7e5db4..a9f456f553 100644 --- a/src/nifake/nifake.mak +++ b/src/nifake/nifake.mak @@ -8,6 +8,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) # We are not building any nifake documentation # RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +# SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) CUSTOM_TYPES_TO_COPY += \ custom_struct.py \ diff --git a/src/nifgen/nifgen.mak b/src/nifgen/nifgen.mak index 95457fc209..24767081ea 100644 --- a/src/nifgen/nifgen.mak +++ b/src/nifgen/nifgen.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nimodinst/nimodinst.mak b/src/nimodinst/nimodinst.mak index be2b6456e1..1b4f3072c7 100644 --- a/src/nimodinst/nimodinst.mak +++ b/src/nimodinst/nimodinst.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst enums.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + include $(BUILD_HELPER_DIR)/rules.mak # We need to override the default rule for generating session since we have diff --git a/src/niscope/niscope.mak b/src/niscope/niscope.mak index 0a1176dc97..d13cec8c88 100644 --- a/src/niscope/niscope.mak +++ b/src/niscope/niscope.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + CUSTOM_TYPES_TO_COPY += \ waveform_info.py \ measurement_stats.py \ diff --git a/src/nise/nise.mak b/src/nise/nise.mak index 1b4f969ae1..f89bf3ffb6 100644 --- a/src/nise/nise.mak +++ b/src/nise/nise.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/niswitch/niswitch.mak b/src/niswitch/niswitch.mak index 95457fc209..8f3d9e027c 100644 --- a/src/niswitch/niswitch.mak +++ b/src/niswitch/niswitch.mak @@ -8,6 +8,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nitclk/nitclk.mak b/src/nitclk/nitclk.mak index 594b80f383..28af09b5bd 100644 --- a/src/nitclk/nitclk.mak +++ b/src/nitclk/nitclk.mak @@ -8,6 +8,8 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst enums.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) +SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) + include $(BUILD_HELPER_DIR)/rules.mak # We need to override the default rule for generating session since we have From 278b784985f155069d212939b779ec73aa62a555 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Wed, 10 May 2023 15:05:11 -0500 Subject: [PATCH 02/31] Generate individual html documentation for each nimi-python package --- README.rst | 2 ++ build/Makefile | 10 ++++++++- build/defines.mak | 4 +++- build/rules.mak | 4 ++++ build/templates/conf.py.mako | 4 +++- build/templates/driver.rst.mako | 16 ++++++++++++++ build/templates/index.rst.mako | 39 +++++++++++++++++++++++++++++++++ build/templates/toc.inc.mako | 12 +++++----- docs/_static/installation.inc | 2 ++ docs/nidcpower.rst | 9 -------- docs/nidcpower/conf.py | 4 +++- docs/nidcpower/index.rst | 33 ++++++++++++++++++++++++++++ docs/nidcpower/nidcpower.rst | 9 ++++++++ docs/nidcpower/toc.inc | 12 +++++----- docs/nidigital.rst | 9 -------- docs/nidigital/conf.py | 4 +++- docs/nidigital/index.rst | 33 ++++++++++++++++++++++++++++ docs/nidigital/nidigital.rst | 9 ++++++++ docs/nidigital/toc.inc | 12 +++++----- docs/nidmm.rst | 10 --------- docs/nidmm/conf.py | 4 +++- docs/nidmm/index.rst | 33 ++++++++++++++++++++++++++++ docs/nidmm/nidmm.rst | 9 ++++++++ docs/nidmm/toc.inc | 10 ++++----- docs/nifgen.rst | 9 -------- docs/nifgen/conf.py | 4 +++- docs/nifgen/index.rst | 33 ++++++++++++++++++++++++++++ docs/nifgen/nifgen.rst | 9 ++++++++ docs/nifgen/toc.inc | 12 +++++----- docs/nimodinst.rst | 10 --------- docs/nimodinst/conf.py | 4 +++- docs/nimodinst/index.rst | 33 ++++++++++++++++++++++++++++ docs/nimodinst/nimodinst.rst | 9 ++++++++ docs/nimodinst/toc.inc | 6 ++--- docs/niscope.rst | 9 -------- docs/niscope/conf.py | 4 +++- docs/niscope/index.rst | 33 ++++++++++++++++++++++++++++ docs/niscope/niscope.rst | 9 ++++++++ docs/niscope/toc.inc | 12 +++++----- docs/nise.rst | 9 -------- docs/nise/conf.py | 4 +++- docs/nise/index.rst | 33 ++++++++++++++++++++++++++++ docs/nise/nise.rst | 9 ++++++++ docs/nise/toc.inc | 8 +++---- docs/niswitch.rst | 10 --------- docs/niswitch/conf.py | 4 +++- docs/niswitch/index.rst | 33 ++++++++++++++++++++++++++++ docs/niswitch/niswitch.rst | 9 ++++++++ docs/niswitch/toc.inc | 12 +++++----- docs/nitclk.rst | 10 --------- docs/nitclk/conf.py | 4 +++- docs/nitclk/index.rst | 33 ++++++++++++++++++++++++++++ docs/nitclk/nitclk.rst | 9 ++++++++ docs/nitclk/toc.inc | 6 ++--- tox-travis.ini | 10 ++++++++- tox.ini | 10 ++++++++- 56 files changed, 552 insertions(+), 150 deletions(-) create mode 100644 build/templates/driver.rst.mako create mode 100644 build/templates/index.rst.mako delete mode 100644 docs/nidcpower.rst create mode 100644 docs/nidcpower/index.rst create mode 100644 docs/nidcpower/nidcpower.rst delete mode 100644 docs/nidigital.rst create mode 100644 docs/nidigital/index.rst create mode 100644 docs/nidigital/nidigital.rst delete mode 100644 docs/nidmm.rst create mode 100644 docs/nidmm/index.rst create mode 100644 docs/nidmm/nidmm.rst delete mode 100644 docs/nifgen.rst create mode 100644 docs/nifgen/index.rst create mode 100644 docs/nifgen/nifgen.rst delete mode 100644 docs/nimodinst.rst create mode 100644 docs/nimodinst/index.rst create mode 100644 docs/nimodinst/nimodinst.rst delete mode 100644 docs/niscope.rst create mode 100644 docs/niscope/index.rst create mode 100644 docs/niscope/niscope.rst delete mode 100644 docs/nise.rst create mode 100644 docs/nise/index.rst create mode 100644 docs/nise/nise.rst delete mode 100644 docs/niswitch.rst create mode 100644 docs/niswitch/index.rst create mode 100644 docs/niswitch/niswitch.rst delete mode 100644 docs/nitclk.rst create mode 100644 docs/nitclk/index.rst create mode 100644 docs/nitclk/nitclk.rst diff --git a/README.rst b/README.rst index d773957beb..d733d04339 100644 --- a/README.rst +++ b/README.rst @@ -421,6 +421,8 @@ Installation Driver specific installation instructions can be found on Read The Docs: +.. # TODO(ni-jfitzger): Update these links + * `nidcpower `_ * `nidigital `_ * `nidmm `_ diff --git a/build/Makefile b/build/Makefile index 61a5a25fda..481232a13b 100644 --- a/build/Makefile +++ b/build/Makefile @@ -146,7 +146,15 @@ endef $(ROOT_DIR)/README.rst: $(GLOBAL_FILES_STARTED_FILE) $(call trace_to_console, "Creating Root",$(notdir $@)) - $(_hide_cmds)$(call global_log_command,cat $(STATIC_DOCS_DIR)/status_project.inc $(STATIC_DOCS_DIR)/about.inc $(DOCS_DIR)/*/status.inc $(STATIC_DOCS_DIR)/installation.inc $(STATIC_DOCS_DIR)/contributing.inc $(STATIC_DOCS_DIR)/nidmm_usage.inc $(STATIC_DOCS_DIR)/support.inc $(STATIC_DOCS_DIR)/documentation.inc $(STATIC_DOCS_DIR)/license.inc > $@) + $(_hide_cmds)$(call global_log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \ + $(STATIC_DOCS_DIR)/about.inc \ + $(DOCS_DIR)/*/status.inc \ + $(STATIC_DOCS_DIR)/installation.inc \ + $(STATIC_DOCS_DIR)/contributing.inc \ + $(STATIC_DOCS_DIR)/nidmm_usage.inc \ + $(STATIC_DOCS_DIR)/support.inc \ + $(STATIC_DOCS_DIR)/documentation.inc \ + $(STATIC_DOCS_DIR)/license.inc > $@) $(ROOT_DIR)/VERSION: $(GLOBAL_FILES_STARTED_FILE) $(call trace_to_console, "Creating Root",$(notdir $@)) tools/update_version_file.py diff --git a/build/defines.mak b/build/defines.mak index 04a85d6158..53585a466d 100644 --- a/build/defines.mak +++ b/build/defines.mak @@ -32,7 +32,7 @@ GRPC_SUPPORTED := $(if $(wildcard $(PROTO_FILE)),$(true)) PYTHON_CMD ?= python GRPC_SUPPORT_PARAM := $(if $(GRPC_SUPPORTED),--include-grpc-support) define GENERATE_SCRIPT -$(PYTHON_CMD) -m build --template $1 --dest-dir $2 --metadata $3 $(if $(PRINT),-v,) $(GRPC_SUPPORT_PARAM) +$(PYTHON_CMD) -m build --template $1 --dest-dir $2 --metadata $3 $(if $4,--dest-file $4) $(if $(PRINT),-v,) $(GRPC_SUPPORT_PARAM) endef ifeq (,$(PRINT)) @@ -75,6 +75,8 @@ DEFAULT_PY_FILES_TO_COPY := \ _visatype.py \ DEFAULT_RST_FILES_TO_GENERATE := \ + index.rst \ + $(DRIVER).rst \ enums.rst \ examples.rst \ installation.inc \ diff --git a/build/rules.mak b/build/rules.mak index 992e04a94f..0de9c7134e 100644 --- a/build/rules.mak +++ b/build/rules.mak @@ -80,6 +80,10 @@ $(DRIVER_DOCS_DIR)/%.rst: %.rst.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) $(call trace_to_console, "Generating",$@) $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) +$(DRIVER_DOCS_DIR)/$(DRIVER).rst: driver.rst.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) + $(call trace_to_console, "Generating",$@) + $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR), $(notdir $@))) + $(DRIVER_DOCS_DIR)/%.inc: %.inc.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) $(call trace_to_console, "Generating",$@) $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index b22db0dccf..15a4ae7b25 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -117,7 +117,7 @@ html_theme_options = { # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -196,5 +196,7 @@ texinfo_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/build/templates/driver.rst.mako b/build/templates/driver.rst.mako new file mode 100644 index 0000000000..b58c5b0c9a --- /dev/null +++ b/build/templates/driver.rst.mako @@ -0,0 +1,16 @@ +<% + '''This is a template for the module-specific .rst''' + + config = template_parameters['metadata'].config + module_name = config['module_name'] + doc_header = f"{module_name} module" +%>\ +${doc_header} +${"=" * len(doc_header)} + +.. include:: installation.inc + +.. include:: ../_static/${module_name}_usage.inc + +.. include:: toc.inc + diff --git a/build/templates/index.rst.mako b/build/templates/index.rst.mako new file mode 100644 index 0000000000..3bcd9b4770 --- /dev/null +++ b/build/templates/index.rst.mako @@ -0,0 +1,39 @@ +<% + config = template_parameters['metadata'].config + doc_header = f"{config['driver_name']} Python API Documentation" + module_name = config['module_name'] + driver_name = config['driver_name'] +%>\ + +${doc_header} +${"=" * len(doc_header)} + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + ${module_name} + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/build/templates/toc.inc.mako b/build/templates/toc.inc.mako index 1788012146..05476c7271 100644 --- a/build/templates/toc.inc.mako +++ b/build/templates/toc.inc.mako @@ -11,16 +11,16 @@ API Reference .. toctree:: - ${module_name}/class + class % if len(config['repeated_capabilities']) > 0: - ${module_name}/rep_caps + rep_caps % endif % if len(enums) > 0: - ${module_name}/enums + enums % endif - ${module_name}/errors - ${module_name}/examples + errors + examples % if grpc_supported: - ${module_name}/grpc_session_options + grpc_session_options % endif diff --git a/docs/_static/installation.inc b/docs/_static/installation.inc index 56ebf79e83..6b535446c1 100644 --- a/docs/_static/installation.inc +++ b/docs/_static/installation.inc @@ -5,6 +5,8 @@ Installation Driver specific installation instructions can be found on Read The Docs: +.. # TODO(ni-jfitzger): Update these links + * `nidcpower `_ * `nidigital `_ * `nidmm `_ diff --git a/docs/nidcpower.rst b/docs/nidcpower.rst deleted file mode 100644 index 77706065d8..0000000000 --- a/docs/nidcpower.rst +++ /dev/null @@ -1,9 +0,0 @@ -nidcpower module -============================================================= - -.. include:: nidcpower/installation.inc - -.. include:: _static/nidcpower_usage.inc - -.. include:: nidcpower/toc.inc - diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index 2f04342f67..1386a9d0eb 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidcpower/index.rst b/docs/nidcpower/index.rst new file mode 100644 index 0000000000..7d7550d008 --- /dev/null +++ b/docs/nidcpower/index.rst @@ -0,0 +1,33 @@ + +NI-DCPower Python API Documentation +=================================== + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nidcpower + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nidcpower/nidcpower.rst b/docs/nidcpower/nidcpower.rst new file mode 100644 index 0000000000..b8438db6ac --- /dev/null +++ b/docs/nidcpower/nidcpower.rst @@ -0,0 +1,9 @@ +nidcpower module +================ + +.. include:: installation.inc + +.. include:: ../_static/nidcpower_usage.inc + +.. include:: toc.inc + diff --git a/docs/nidcpower/toc.inc b/docs/nidcpower/toc.inc index 076a1fad22..300092a6ce 100644 --- a/docs/nidcpower/toc.inc +++ b/docs/nidcpower/toc.inc @@ -3,10 +3,10 @@ API Reference .. toctree:: - nidcpower/class - nidcpower/rep_caps - nidcpower/enums - nidcpower/errors - nidcpower/examples - nidcpower/grpc_session_options + class + rep_caps + enums + errors + examples + grpc_session_options diff --git a/docs/nidigital.rst b/docs/nidigital.rst deleted file mode 100644 index 7e1cfe799e..0000000000 --- a/docs/nidigital.rst +++ /dev/null @@ -1,9 +0,0 @@ -nidigital module -============================================================= - -.. include:: nidigital/installation.inc - -.. include:: _static/nidigital_usage.inc - -.. include:: nidigital/toc.inc - diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index f661ed81eb..6f6c79423e 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidigital/index.rst b/docs/nidigital/index.rst new file mode 100644 index 0000000000..41a334a428 --- /dev/null +++ b/docs/nidigital/index.rst @@ -0,0 +1,33 @@ + +NI-Digital Pattern Driver Python API Documentation +================================================== + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nidigital + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nidigital/nidigital.rst b/docs/nidigital/nidigital.rst new file mode 100644 index 0000000000..24055e8327 --- /dev/null +++ b/docs/nidigital/nidigital.rst @@ -0,0 +1,9 @@ +nidigital module +================ + +.. include:: installation.inc + +.. include:: ../_static/nidigital_usage.inc + +.. include:: toc.inc + diff --git a/docs/nidigital/toc.inc b/docs/nidigital/toc.inc index 0a79ecec4f..300092a6ce 100644 --- a/docs/nidigital/toc.inc +++ b/docs/nidigital/toc.inc @@ -3,10 +3,10 @@ API Reference .. toctree:: - nidigital/class - nidigital/rep_caps - nidigital/enums - nidigital/errors - nidigital/examples - nidigital/grpc_session_options + class + rep_caps + enums + errors + examples + grpc_session_options diff --git a/docs/nidmm.rst b/docs/nidmm.rst deleted file mode 100644 index fd002def0d..0000000000 --- a/docs/nidmm.rst +++ /dev/null @@ -1,10 +0,0 @@ -nidmm module -============================================================= - -.. include:: nidmm/installation.inc - -.. include:: _static/nidmm_usage.inc - -.. include:: nidmm/toc.inc - - diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index 7f41a2ed85..dcf622d0ac 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidmm/index.rst b/docs/nidmm/index.rst new file mode 100644 index 0000000000..1c9354c265 --- /dev/null +++ b/docs/nidmm/index.rst @@ -0,0 +1,33 @@ + +NI-DMM Python API Documentation +=============================== + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nidmm + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nidmm/nidmm.rst b/docs/nidmm/nidmm.rst new file mode 100644 index 0000000000..671834d1c3 --- /dev/null +++ b/docs/nidmm/nidmm.rst @@ -0,0 +1,9 @@ +nidmm module +============ + +.. include:: installation.inc + +.. include:: ../_static/nidmm_usage.inc + +.. include:: toc.inc + diff --git a/docs/nidmm/toc.inc b/docs/nidmm/toc.inc index 4d799cd197..df05959018 100644 --- a/docs/nidmm/toc.inc +++ b/docs/nidmm/toc.inc @@ -3,9 +3,9 @@ API Reference .. toctree:: - nidmm/class - nidmm/enums - nidmm/errors - nidmm/examples - nidmm/grpc_session_options + class + enums + errors + examples + grpc_session_options diff --git a/docs/nifgen.rst b/docs/nifgen.rst deleted file mode 100644 index 639fa8ae73..0000000000 --- a/docs/nifgen.rst +++ /dev/null @@ -1,9 +0,0 @@ -nifgen module -============================================================= - -.. include:: nifgen/installation.inc - -.. include:: _static/nifgen_usage.inc - -.. include:: nifgen/toc.inc - diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 5b8c8188c0..632e6e31b8 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nifgen/index.rst b/docs/nifgen/index.rst new file mode 100644 index 0000000000..9e6d3a6e91 --- /dev/null +++ b/docs/nifgen/index.rst @@ -0,0 +1,33 @@ + +NI-FGEN Python API Documentation +================================ + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nifgen + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nifgen/nifgen.rst b/docs/nifgen/nifgen.rst new file mode 100644 index 0000000000..a0df8b7a93 --- /dev/null +++ b/docs/nifgen/nifgen.rst @@ -0,0 +1,9 @@ +nifgen module +============= + +.. include:: installation.inc + +.. include:: ../_static/nifgen_usage.inc + +.. include:: toc.inc + diff --git a/docs/nifgen/toc.inc b/docs/nifgen/toc.inc index 453c42dab5..300092a6ce 100644 --- a/docs/nifgen/toc.inc +++ b/docs/nifgen/toc.inc @@ -3,10 +3,10 @@ API Reference .. toctree:: - nifgen/class - nifgen/rep_caps - nifgen/enums - nifgen/errors - nifgen/examples - nifgen/grpc_session_options + class + rep_caps + enums + errors + examples + grpc_session_options diff --git a/docs/nimodinst.rst b/docs/nimodinst.rst deleted file mode 100644 index e36d9c609d..0000000000 --- a/docs/nimodinst.rst +++ /dev/null @@ -1,10 +0,0 @@ -nimodinst module -============================================================= - -.. include:: nimodinst/installation.inc - -.. include:: _static/nimodinst_usage.inc - -.. include:: nimodinst/toc.inc - - diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index 8ed1f5ff15..2e40c37e03 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nimodinst/index.rst b/docs/nimodinst/index.rst new file mode 100644 index 0000000000..db10c06e88 --- /dev/null +++ b/docs/nimodinst/index.rst @@ -0,0 +1,33 @@ + +NI-ModInst Python API Documentation +=================================== + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nimodinst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nimodinst/nimodinst.rst b/docs/nimodinst/nimodinst.rst new file mode 100644 index 0000000000..c2811b4f38 --- /dev/null +++ b/docs/nimodinst/nimodinst.rst @@ -0,0 +1,9 @@ +nimodinst module +================ + +.. include:: installation.inc + +.. include:: ../_static/nimodinst_usage.inc + +.. include:: toc.inc + diff --git a/docs/nimodinst/toc.inc b/docs/nimodinst/toc.inc index 516363e096..f4c0c73875 100644 --- a/docs/nimodinst/toc.inc +++ b/docs/nimodinst/toc.inc @@ -3,7 +3,7 @@ API Reference .. toctree:: - nimodinst/class - nimodinst/errors - nimodinst/examples + class + errors + examples diff --git a/docs/niscope.rst b/docs/niscope.rst deleted file mode 100644 index fa8a71fcf5..0000000000 --- a/docs/niscope.rst +++ /dev/null @@ -1,9 +0,0 @@ -niscope module -============================================================= - -.. include:: niscope/installation.inc - -.. include:: _static/niscope_usage.inc - -.. include:: niscope/toc.inc - diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index 34acb788d2..859a14ce35 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/niscope/index.rst b/docs/niscope/index.rst new file mode 100644 index 0000000000..d1f14b56a1 --- /dev/null +++ b/docs/niscope/index.rst @@ -0,0 +1,33 @@ + +NI-SCOPE Python API Documentation +================================= + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + niscope + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/niscope/niscope.rst b/docs/niscope/niscope.rst new file mode 100644 index 0000000000..9d6ceba6b7 --- /dev/null +++ b/docs/niscope/niscope.rst @@ -0,0 +1,9 @@ +niscope module +============== + +.. include:: installation.inc + +.. include:: ../_static/niscope_usage.inc + +.. include:: toc.inc + diff --git a/docs/niscope/toc.inc b/docs/niscope/toc.inc index f5ee1fea47..300092a6ce 100644 --- a/docs/niscope/toc.inc +++ b/docs/niscope/toc.inc @@ -3,10 +3,10 @@ API Reference .. toctree:: - niscope/class - niscope/rep_caps - niscope/enums - niscope/errors - niscope/examples - niscope/grpc_session_options + class + rep_caps + enums + errors + examples + grpc_session_options diff --git a/docs/nise.rst b/docs/nise.rst deleted file mode 100644 index 153a4e9faa..0000000000 --- a/docs/nise.rst +++ /dev/null @@ -1,9 +0,0 @@ -nise module -============================================================= - -.. include:: nise/installation.inc - -.. include:: _static/nise_usage.inc - -.. include:: nise/toc.inc - diff --git a/docs/nise/conf.py b/docs/nise/conf.py index 0432893924..72281a69f9 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nise/index.rst b/docs/nise/index.rst new file mode 100644 index 0000000000..0b93b2f442 --- /dev/null +++ b/docs/nise/index.rst @@ -0,0 +1,33 @@ + +NI Switch Executive Python API Documentation +============================================ + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nise + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nise/nise.rst b/docs/nise/nise.rst new file mode 100644 index 0000000000..4db377e53e --- /dev/null +++ b/docs/nise/nise.rst @@ -0,0 +1,9 @@ +nise module +=========== + +.. include:: installation.inc + +.. include:: ../_static/nise_usage.inc + +.. include:: toc.inc + diff --git a/docs/nise/toc.inc b/docs/nise/toc.inc index 70f6c1da69..5f64afcd41 100644 --- a/docs/nise/toc.inc +++ b/docs/nise/toc.inc @@ -3,8 +3,8 @@ API Reference .. toctree:: - nise/class - nise/enums - nise/errors - nise/examples + class + enums + errors + examples diff --git a/docs/niswitch.rst b/docs/niswitch.rst deleted file mode 100644 index 7dedbcefe7..0000000000 --- a/docs/niswitch.rst +++ /dev/null @@ -1,10 +0,0 @@ -niswitch module -============================================================= - -.. include:: niswitch/installation.inc - -.. include:: _static/niswitch_usage.inc - -.. include:: niswitch/toc.inc - - diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index 133f6a75ad..7efb2b315f 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/niswitch/index.rst b/docs/niswitch/index.rst new file mode 100644 index 0000000000..3956643664 --- /dev/null +++ b/docs/niswitch/index.rst @@ -0,0 +1,33 @@ + +NI-SWITCH Python API Documentation +================================== + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + niswitch + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/niswitch/niswitch.rst b/docs/niswitch/niswitch.rst new file mode 100644 index 0000000000..b43ed42239 --- /dev/null +++ b/docs/niswitch/niswitch.rst @@ -0,0 +1,9 @@ +niswitch module +=============== + +.. include:: installation.inc + +.. include:: ../_static/niswitch_usage.inc + +.. include:: toc.inc + diff --git a/docs/niswitch/toc.inc b/docs/niswitch/toc.inc index 26d2b3dee7..300092a6ce 100644 --- a/docs/niswitch/toc.inc +++ b/docs/niswitch/toc.inc @@ -3,10 +3,10 @@ API Reference .. toctree:: - niswitch/class - niswitch/rep_caps - niswitch/enums - niswitch/errors - niswitch/examples - niswitch/grpc_session_options + class + rep_caps + enums + errors + examples + grpc_session_options diff --git a/docs/nitclk.rst b/docs/nitclk.rst deleted file mode 100644 index 3ed9498624..0000000000 --- a/docs/nitclk.rst +++ /dev/null @@ -1,10 +0,0 @@ -nitclk module -============================================================= - -.. include:: nitclk/installation.inc - -.. include:: _static/nitclk_usage.inc - -.. include:: nitclk/toc.inc - - diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index 9ddcd0c346..e2cb47e714 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -106,7 +106,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['../_static'] # Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 def setup(app): @@ -185,5 +185,7 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. +# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nitclk/index.rst b/docs/nitclk/index.rst new file mode 100644 index 0000000000..8daec08d82 --- /dev/null +++ b/docs/nitclk/index.rst @@ -0,0 +1,33 @@ + +NI-TClk Python API Documentation +================================ + +.. include:: ../_static/about.inc + +.. include:: ../_static/installation.inc + +.. include:: ../_static/contributing.inc + +.. include:: ../_static/support.inc + +.. include:: ../_static/documentation.inc + +Additional Documentation +------------------------ + +Refer to your driver documentation for device-specific information and detailed API documentation. + + +.. include:: ../_static/license.inc + +.. toctree:: + :maxdepth: 3 + + nitclk + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/nitclk/nitclk.rst b/docs/nitclk/nitclk.rst new file mode 100644 index 0000000000..24aecf34cb --- /dev/null +++ b/docs/nitclk/nitclk.rst @@ -0,0 +1,9 @@ +nitclk module +============= + +.. include:: installation.inc + +.. include:: ../_static/nitclk_usage.inc + +.. include:: toc.inc + diff --git a/docs/nitclk/toc.inc b/docs/nitclk/toc.inc index 23642cd311..f4c0c73875 100644 --- a/docs/nitclk/toc.inc +++ b/docs/nitclk/toc.inc @@ -3,7 +3,7 @@ API Reference .. toctree:: - nitclk/class - nitclk/errors - nitclk/examples + class + errors + examples diff --git a/tox-travis.ini b/tox-travis.ini index da75d00186..7a03d28348 100644 --- a/tox-travis.ini +++ b/tox-travis.ini @@ -104,7 +104,15 @@ commands = flake8: flake8 --config=./tox.ini src/nitclk/system_tests/ src/nitclk/examples/ docs: python --version docs: python -c "import platform; print(platform.architecture())" - docs: sphinx-build -b html -d {envtmpdir}/doctrees . ../generated/docs/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidcpower ../generated/docs/nidcpower/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidigital ../generated/docs/nidigital/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidmm ../generated/docs/nidmm/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nifgen ../generated/docs/nifgen/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nimodinst ../generated/docs/nimodinst/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./niscope ../generated/docs/niscope/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nise ../generated/docs/nise/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./niswitch ../generated/docs/niswitch/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nitclk ../generated/docs/nitclk/html {posargs} pkg: python --version pkg: python -c "import platform; print(platform.architecture())" pkg: python -m twine --version diff --git a/tox.ini b/tox.ini index 3f82bd6ef4..707027a7bc 100644 --- a/tox.ini +++ b/tox.ini @@ -104,7 +104,15 @@ commands = flake8: flake8 --config=./tox.ini src/nitclk/system_tests/ src/nitclk/examples/ docs: python --version docs: python -c "import platform; print(platform.architecture())" - docs: sphinx-build -b html -d {envtmpdir}/doctrees . ../generated/docs/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidcpower ../generated/docs/nidcpower/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidigital ../generated/docs/nidigital/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nidmm ../generated/docs/nidmm/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nifgen ../generated/docs/nifgen/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nimodinst ../generated/docs/nimodinst/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./niscope ../generated/docs/niscope/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nise ../generated/docs/nise/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./niswitch ../generated/docs/niswitch/html {posargs} + docs: sphinx-build -b html -d {envtmpdir}/doctrees ./nitclk ../generated/docs/nitclk/html {posargs} pkg: python --version pkg: python -c "import platform; print(platform.architecture())" pkg: python -m twine --version From 8a30afce7b4d2bb3b0e291e8280377629435439c Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Wed, 10 May 2023 16:24:51 -0500 Subject: [PATCH 03/31] Clean up index page --- build/templates/index.rst.mako | 15 ++++++--------- docs/_static/about_driver.inc | 14 ++++++++++++++ docs/nidcpower/index.rst | 15 ++++++--------- docs/nidigital/index.rst | 15 ++++++--------- docs/nidmm/index.rst | 15 ++++++--------- docs/nifgen/index.rst | 15 ++++++--------- docs/nimodinst/index.rst | 15 ++++++--------- docs/niscope/index.rst | 15 ++++++--------- docs/nise/index.rst | 15 ++++++--------- docs/niswitch/index.rst | 15 ++++++--------- docs/nitclk/index.rst | 15 ++++++--------- 11 files changed, 74 insertions(+), 90 deletions(-) create mode 100644 docs/_static/about_driver.inc diff --git a/build/templates/index.rst.mako b/build/templates/index.rst.mako index 3bcd9b4770..f41073ab6b 100644 --- a/build/templates/index.rst.mako +++ b/build/templates/index.rst.mako @@ -8,15 +8,17 @@ ${doc_header} ${"=" * len(doc_header)} -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + ${module_name} Additional Documentation ------------------------ @@ -26,11 +28,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - ${module_name} - Indices and tables ================== diff --git a/docs/_static/about_driver.inc b/docs/_static/about_driver.inc new file mode 100644 index 0000000000..60c78bbb55 --- /dev/null +++ b/docs/_static/about_driver.inc @@ -0,0 +1,14 @@ +.. _about-section: + +About +===== + +This package, which is maintained in the `**nimi-python** repository `_, provides a Python API for the associated driver. + +Support Policy +-------------- +This package supports all the Operating Systems supported by the underlying driver. + +It follows `Python Software Foundation `_ support policy for different versions. At +this time this includes Python 3.7 and above using CPython. + diff --git a/docs/nidcpower/index.rst b/docs/nidcpower/index.rst index 7d7550d008..1a55e4c3fe 100644 --- a/docs/nidcpower/index.rst +++ b/docs/nidcpower/index.rst @@ -2,15 +2,17 @@ NI-DCPower Python API Documentation =================================== -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nidcpower Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nidcpower - Indices and tables ================== diff --git a/docs/nidigital/index.rst b/docs/nidigital/index.rst index 41a334a428..d13e60052e 100644 --- a/docs/nidigital/index.rst +++ b/docs/nidigital/index.rst @@ -2,15 +2,17 @@ NI-Digital Pattern Driver Python API Documentation ================================================== -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nidigital Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nidigital - Indices and tables ================== diff --git a/docs/nidmm/index.rst b/docs/nidmm/index.rst index 1c9354c265..bc258f0bbc 100644 --- a/docs/nidmm/index.rst +++ b/docs/nidmm/index.rst @@ -2,15 +2,17 @@ NI-DMM Python API Documentation =============================== -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nidmm Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nidmm - Indices and tables ================== diff --git a/docs/nifgen/index.rst b/docs/nifgen/index.rst index 9e6d3a6e91..08838a63c1 100644 --- a/docs/nifgen/index.rst +++ b/docs/nifgen/index.rst @@ -2,15 +2,17 @@ NI-FGEN Python API Documentation ================================ -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nifgen Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nifgen - Indices and tables ================== diff --git a/docs/nimodinst/index.rst b/docs/nimodinst/index.rst index db10c06e88..e96e01bdc5 100644 --- a/docs/nimodinst/index.rst +++ b/docs/nimodinst/index.rst @@ -2,15 +2,17 @@ NI-ModInst Python API Documentation =================================== -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nimodinst Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nimodinst - Indices and tables ================== diff --git a/docs/niscope/index.rst b/docs/niscope/index.rst index d1f14b56a1..3a9383da32 100644 --- a/docs/niscope/index.rst +++ b/docs/niscope/index.rst @@ -2,15 +2,17 @@ NI-SCOPE Python API Documentation ================================= -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + niscope Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - niscope - Indices and tables ================== diff --git a/docs/nise/index.rst b/docs/nise/index.rst index 0b93b2f442..30c55bbc32 100644 --- a/docs/nise/index.rst +++ b/docs/nise/index.rst @@ -2,15 +2,17 @@ NI Switch Executive Python API Documentation ============================================ -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nise Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nise - Indices and tables ================== diff --git a/docs/niswitch/index.rst b/docs/niswitch/index.rst index 3956643664..522da2c1bd 100644 --- a/docs/niswitch/index.rst +++ b/docs/niswitch/index.rst @@ -2,15 +2,17 @@ NI-SWITCH Python API Documentation ================================== -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + niswitch Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - niswitch - Indices and tables ================== diff --git a/docs/nitclk/index.rst b/docs/nitclk/index.rst index 8daec08d82..d28b323189 100644 --- a/docs/nitclk/index.rst +++ b/docs/nitclk/index.rst @@ -2,15 +2,17 @@ NI-TClk Python API Documentation ================================ -.. include:: ../_static/about.inc - -.. include:: ../_static/installation.inc +.. include:: ../_static/about_driver.inc .. include:: ../_static/contributing.inc .. include:: ../_static/support.inc -.. include:: ../_static/documentation.inc +.. toctree:: + :maxdepth: 3 + :caption: Documentation + + nitclk Additional Documentation ------------------------ @@ -20,11 +22,6 @@ Refer to your driver documentation for device-specific information and detailed .. include:: ../_static/license.inc -.. toctree:: - :maxdepth: 3 - - nitclk - Indices and tables ================== From a004562686d25f9302a65b0ae5f2fc92f5e4545c Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Wed, 10 May 2023 16:52:35 -0500 Subject: [PATCH 04/31] Add TODO for release process --- tools/build_release.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/build_release.py b/tools/build_release.py index 3720877d1d..361ba67f1b 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -21,6 +21,7 @@ class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescri ''' pass +# TODO(ni-jfitzger): update this file to work for individual pacakge releases. def main(): # Setup the required arguments for this script From 7aff573d79368522a1be85f8275a60704fda2908 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 09:11:20 -0500 Subject: [PATCH 05/31] Fix flake8 error --- tools/build_release.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/build_release.py b/tools/build_release.py index 361ba67f1b..fff5808f6b 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -1,4 +1,5 @@ # !python +# TODO(ni-jfitzger): update this file to work for individual package releases. import argparse from configure_logging import configure_logging @@ -21,7 +22,6 @@ class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescri ''' pass -# TODO(ni-jfitzger): update this file to work for individual pacakge releases. def main(): # Setup the required arguments for this script From da434b828b80df0d9fb9e63710bec9a70250b33a Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 11:06:13 -0500 Subject: [PATCH 06/31] Delete now-unused Root VERSION file --- VERSION | 1 - build/Makefile | 5 ----- 2 files changed, 6 deletions(-) delete mode 100644 VERSION diff --git a/VERSION b/VERSION deleted file mode 100644 index d52d73c327..0000000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -1.4.5.dev0 \ No newline at end of file diff --git a/build/Makefile b/build/Makefile index 481232a13b..a177970490 100644 --- a/build/Makefile +++ b/build/Makefile @@ -23,7 +23,6 @@ endif ifeq (,$(MAKECMDGOALS)) ROOT_FILES := \ $(ROOT_DIR)/README.rst \ - $(ROOT_DIR)/VERSION \ endif @@ -156,10 +155,6 @@ $(ROOT_DIR)/README.rst: $(GLOBAL_FILES_STARTED_FILE) $(STATIC_DOCS_DIR)/documentation.inc \ $(STATIC_DOCS_DIR)/license.inc > $@) -$(ROOT_DIR)/VERSION: $(GLOBAL_FILES_STARTED_FILE) - $(call trace_to_console, "Creating Root",$(notdir $@)) tools/update_version_file.py - $(_hide_cmds)$(call global_log_command,$(PYTHON_CMD) tools/update_version_file.py --output-file $@ $(foreach d,$(DRIVERS),--input-file $(GENERATED_DIR)/$(d)/$(d)/VERSION )) - # Any step that any driver build does that would invalidate unit testing, flake8 or generated html # needs to delete this file. This will trigger a tox run. TOX_RUN_DONE := $(GENERATED_DIR)/tox_run_done From 071f7013207e73a9926a65bbd754dd84b1c222fe Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 11:41:15 -0500 Subject: [PATCH 07/31] Split LATEST_RELEASE file used for generating example.rst --- build/templates/examples.rst.mako | 2 +- LATEST_RELEASE => src/nidcpower/LATEST_RELEASE | 0 src/nidigital/LATEST_RELEASE | 1 + src/nidmm/LATEST_RELEASE | 1 + src/nifgen/LATEST_RELEASE | 1 + src/nimodinst/LATEST_RELEASE | 1 + src/niscope/LATEST_RELEASE | 1 + src/nise/LATEST_RELEASE | 1 + src/niswitch/LATEST_RELEASE | 1 + src/nitclk/LATEST_RELEASE | 1 + tools/build_release.py | 6 +++++- 11 files changed, 14 insertions(+), 2 deletions(-) rename LATEST_RELEASE => src/nidcpower/LATEST_RELEASE (100%) create mode 100644 src/nidigital/LATEST_RELEASE create mode 100644 src/nidmm/LATEST_RELEASE create mode 100644 src/nifgen/LATEST_RELEASE create mode 100644 src/nimodinst/LATEST_RELEASE create mode 100644 src/niscope/LATEST_RELEASE create mode 100644 src/nise/LATEST_RELEASE create mode 100644 src/niswitch/LATEST_RELEASE create mode 100644 src/nitclk/LATEST_RELEASE diff --git a/build/templates/examples.rst.mako b/build/templates/examples.rst.mako index 52bafc2e24..cbc8148429 100644 --- a/build/templates/examples.rst.mako +++ b/build/templates/examples.rst.mako @@ -25,7 +25,7 @@ # - (1) will link to the zip file for the current release # - (2) will include current code snippet and URL will point to release version - with open('./LATEST_RELEASE') as vf: + with open(f'./src/{module_name}/LATEST_RELEASE') as vf: latest_release_version = vf.read().strip() released_zip_url = 'https://github.com/ni/nimi-python/releases/download/{0}/{1}_examples.zip'.format(latest_release_version, module_name) diff --git a/LATEST_RELEASE b/src/nidcpower/LATEST_RELEASE similarity index 100% rename from LATEST_RELEASE rename to src/nidcpower/LATEST_RELEASE diff --git a/src/nidigital/LATEST_RELEASE b/src/nidigital/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nidigital/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/nidmm/LATEST_RELEASE b/src/nidmm/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nidmm/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/nifgen/LATEST_RELEASE b/src/nifgen/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nifgen/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/nimodinst/LATEST_RELEASE b/src/nimodinst/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nimodinst/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/niscope/LATEST_RELEASE b/src/niscope/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/niscope/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/nise/LATEST_RELEASE b/src/nise/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nise/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/niswitch/LATEST_RELEASE b/src/niswitch/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/niswitch/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/src/nitclk/LATEST_RELEASE b/src/nitclk/LATEST_RELEASE new file mode 100644 index 0000000000..1c99cf0e80 --- /dev/null +++ b/src/nitclk/LATEST_RELEASE @@ -0,0 +1 @@ +1.4.4 diff --git a/tools/build_release.py b/tools/build_release.py index fff5808f6b..6e9d71ce13 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -1,5 +1,9 @@ # !python # TODO(ni-jfitzger): update this file to work for individual package releases. +# Specifics: +# * update LATEST_RELEASE files: figure out for instructions if it neeeds to include driver name for a correct url in examples.rst, rather than just X.Y.Z +# * update "Create a release on GitHub" step instructions to be for each individual package releasing. We may need to name/tag releases differently. +# * update "Update CHANGELOG.md" instructions to whatever new process is. import argparse from configure_logging import configure_logging @@ -39,7 +43,7 @@ def main(): * Change the "Unreleased" header to the version of the release * Change [Unreleased] in TOC to the version of the release * Commit to branch - * Update contents of LATEST_RELEASE with the version of the release being created. + * Update contents of src//LATEST_RELEASE with the version of the release being created. * `python3 tools/build_release.py --update --release` * This will update all the versions to remove any '.devN' * Commit to branch From 5a49372994a83f1d34491749f9c66a4e694a612f Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 13:23:08 -0500 Subject: [PATCH 08/31] Tweak wording; nimi-python is not a package, but a repo. --- README.rst | 2 +- docs/_static/support.inc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index d733d04339..020614e5e5 100644 --- a/README.rst +++ b/README.rst @@ -458,7 +458,7 @@ The following is a basic example of using the **nidmm** module to open a session Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/docs/_static/support.inc b/docs/_static/support.inc index 4f910461d9..1ab7f35675 100644 --- a/docs/_static/support.inc +++ b/docs/_static/support.inc @@ -3,7 +3,7 @@ Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: From 786e64f383f7cbca99ea09d8425e3f61a2a1e214 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 13:31:15 -0500 Subject: [PATCH 09/31] Add another TODO --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b3e335984e..494cefde78 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,4 @@ + # Changelog * [Unreleased](#unreleased) From ed2371b28b0cf682f7ad74ca01ddadca9d70518c Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 13:38:02 -0500 Subject: [PATCH 10/31] Forgot to regenerate in a previous commit --- generated/nidcpower/README.rst | 2 +- generated/nidigital/README.rst | 2 +- generated/nidmm/README.rst | 2 +- generated/nifgen/README.rst | 2 +- generated/nimodinst/README.rst | 2 +- generated/niscope/README.rst | 2 +- generated/nise/README.rst | 2 +- generated/niswitch/README.rst | 2 +- generated/nitclk/README.rst | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/generated/nidcpower/README.rst b/generated/nidcpower/README.rst index 5aee69bd7a..979b094033 100644 --- a/generated/nidcpower/README.rst +++ b/generated/nidcpower/README.rst @@ -160,7 +160,7 @@ The following is a basic example of using the **nidcpower** module to open a ses Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nidigital/README.rst b/generated/nidigital/README.rst index e27a142c55..3d7502474b 100644 --- a/generated/nidigital/README.rst +++ b/generated/nidigital/README.rst @@ -170,7 +170,7 @@ source current, and measure both voltage and current using the PPMU on selected Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nidmm/README.rst b/generated/nidmm/README.rst index 03186da819..4648284065 100644 --- a/generated/nidmm/README.rst +++ b/generated/nidmm/README.rst @@ -139,7 +139,7 @@ The following is a basic example of using the **nidmm** module to open a session Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nifgen/README.rst b/generated/nifgen/README.rst index 3d2d31a205..53406b9b77 100644 --- a/generated/nifgen/README.rst +++ b/generated/nifgen/README.rst @@ -142,7 +142,7 @@ The following is a basic example of using the **nifgen** module to open a sessio Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nimodinst/README.rst b/generated/nimodinst/README.rst index c6d7e3c998..f42219f669 100644 --- a/generated/nimodinst/README.rst +++ b/generated/nimodinst/README.rst @@ -139,7 +139,7 @@ The following is a basic example of using the **nimodinst** module to retrieve i Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/niscope/README.rst b/generated/niscope/README.rst index 313801c2d4..2c381542a2 100644 --- a/generated/niscope/README.rst +++ b/generated/niscope/README.rst @@ -228,7 +228,7 @@ The waveform_infos returned from `fetch_into `_ i Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nise/README.rst b/generated/nise/README.rst index 252d8ca739..224caa6a45 100644 --- a/generated/nise/README.rst +++ b/generated/nise/README.rst @@ -138,7 +138,7 @@ The following is a basic example of using the **nise** module to open a session Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/niswitch/README.rst b/generated/niswitch/README.rst index bb9f656e5f..502ff12824 100644 --- a/generated/niswitch/README.rst +++ b/generated/niswitch/README.rst @@ -138,7 +138,7 @@ The following is a basic example of using the **niswitch** module to open a sess Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: diff --git a/generated/nitclk/README.rst b/generated/nitclk/README.rst index d262106c4e..d86e130612 100644 --- a/generated/nitclk/README.rst +++ b/generated/nitclk/README.rst @@ -136,7 +136,7 @@ The following is a basic example of using the **nitclk** module Support / Feedback ================== -The packages included in **nimi-python** package are supported by NI. For support, open +The packages included in the **nimi-python** repository are supported by NI. For support, open a request through the NI support portal at `ni.com `_. .. _bugs-section: From b21627bd0529618cce54433599bfe5bad5854054 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 14:25:28 -0500 Subject: [PATCH 11/31] Update nidcpower readthedocs link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 020614e5e5..bfae9e9495 100644 --- a/README.rst +++ b/README.rst @@ -423,7 +423,7 @@ Driver specific installation instructions can be found on Read The Docs: .. # TODO(ni-jfitzger): Update these links -* `nidcpower `_ +* `nidcpower `_ * `nidigital `_ * `nidmm `_ * `nifgen `_ From 512387ce11b312db68a70c1c53a11da31758b0f0 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Thu, 11 May 2023 15:51:35 -0500 Subject: [PATCH 12/31] Update readthedocs links --- README.rst | 18 ++++++++---------- docs/_static/installation.inc | 20 +++++++++----------- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index bfae9e9495..1ee45d3a42 100644 --- a/README.rst +++ b/README.rst @@ -421,17 +421,15 @@ Installation Driver specific installation instructions can be found on Read The Docs: -.. # TODO(ni-jfitzger): Update these links - * `nidcpower `_ -* `nidigital `_ -* `nidmm `_ -* `nifgen `_ -* `nimodinst `_ -* `niscope `_ -* `nise `_ -* `niswitch `_ -* `nitclk `_ +* `nidigital `_ +* `nidmm `_ +* `nifgen `_ +* `nimodinst `_ +* `niscope `_ +* `nise `_ +* `niswitch `_ +* `nitclk `_ Contributing diff --git a/docs/_static/installation.inc b/docs/_static/installation.inc index 6b535446c1..f8ab642361 100644 --- a/docs/_static/installation.inc +++ b/docs/_static/installation.inc @@ -5,16 +5,14 @@ Installation Driver specific installation instructions can be found on Read The Docs: -.. # TODO(ni-jfitzger): Update these links - -* `nidcpower `_ -* `nidigital `_ -* `nidmm `_ -* `nifgen `_ -* `nimodinst `_ -* `niscope `_ -* `nise `_ -* `niswitch `_ -* `nitclk `_ +* `nidcpower `_ +* `nidigital `_ +* `nidmm `_ +* `nifgen `_ +* `nimodinst `_ +* `niscope `_ +* `nise `_ +* `niswitch `_ +* `nitclk `_ From d664b20094b11e55f624a4ca2884ce9a91367ed4 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 08:27:36 -0500 Subject: [PATCH 13/31] Delete variable that I don't need after all --- Makefile | 1 - 1 file changed, 1 deletion(-) diff --git a/Makefile b/Makefile index 0693e8bb85..ea6fe2f2c1 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,6 @@ # - 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 niscope niswitch nise nimodinst nitclk -DRIVERS_WITH_DOCS := nidcpower nidigital nidmm nifgen niscope niswitch nise nimodinst nitclk DRIVERS ?= $(ALL_DRIVERS) ROOT_DIR := $(abspath .) From 51dd7c9260a8724d1d9ad4602a387822d2561f79 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 10:49:13 -0500 Subject: [PATCH 14/31] Remove TODO about leaving project name unchanged. That value controls what appears in the top left corner of the built html docs. --- build/templates/conf.py.mako | 1 - docs/nidcpower/conf.py | 1 - docs/nidigital/conf.py | 1 - docs/nidmm/conf.py | 1 - docs/nifgen/conf.py | 1 - docs/nimodinst/conf.py | 1 - docs/niscope/conf.py | 1 - docs/nise/conf.py | 1 - docs/niswitch/conf.py | 1 - docs/nitclk/conf.py | 1 - 10 files changed, 10 deletions(-) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index 15a4ae7b25..28c2689a83 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -65,7 +65,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = '${api_name}' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-${current_year}, National Instruments Corporation' diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index 1386a9d0eb..70a0da846d 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-DCPower Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index 6f6c79423e..8a9d6e90c9 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-Digital Pattern Driver Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index dcf622d0ac..7c758e3a8d 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-DMM Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 632e6e31b8..78c28bc0b6 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-FGEN Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index 2e40c37e03..b7320ba163 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-ModInst Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index 859a14ce35..259f5036c8 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-SCOPE Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nise/conf.py b/docs/nise/conf.py index 72281a69f9..da0b5631e8 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI Switch Executive Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index 7efb2b315f..e537628f55 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-SWITCH Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index e2cb47e714..07bf873ef1 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -54,7 +54,6 @@ master_doc = 'index' # General information about the project. -# TODO(ni-jfitzger): Should we leave the project name unchanged? project = 'NI-TClk Python API' # TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' From f4021316e67e0b46b60e55eec327b0089e3d59e8 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 10:54:21 -0500 Subject: [PATCH 15/31] Remove CHANGELOG todo in build_release.py CHANGELOG split is being handled in a separate PR --- tools/build_release.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tools/build_release.py b/tools/build_release.py index 6e9d71ce13..6e740c300e 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -3,7 +3,6 @@ # Specifics: # * update LATEST_RELEASE files: figure out for instructions if it neeeds to include driver name for a correct url in examples.rst, rather than just X.Y.Z # * update "Create a release on GitHub" step instructions to be for each individual package releasing. We may need to name/tag releases differently. -# * update "Update CHANGELOG.md" instructions to whatever new process is. import argparse from configure_logging import configure_logging From bcb0e6552fa1a780b8c23224590f47e75aaccb3d Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 12:30:10 -0500 Subject: [PATCH 16/31] Remove update links todo We should use redirects in the ReadTheDocs project for that. --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 494cefde78..b3e335984e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,3 @@ - # Changelog * [Unreleased](#unreleased) From ae3dcf357441178e4e1051460e734297ce9d0dcc Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 12:36:23 -0500 Subject: [PATCH 17/31] Use mako comments so that TODO only appears in one place --- build/templates/conf.py.mako | 4 ++-- docs/nidcpower/conf.py | 2 -- docs/nidigital/conf.py | 2 -- docs/nidmm/conf.py | 2 -- docs/nifgen/conf.py | 2 -- docs/nimodinst/conf.py | 2 -- docs/niscope/conf.py | 2 -- docs/nise/conf.py | 2 -- docs/niswitch/conf.py | 2 -- docs/nitclk/conf.py | 2 -- 10 files changed, 2 insertions(+), 20 deletions(-) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index 28c2689a83..dc38030955 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -195,7 +195,7 @@ texinfo_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) +## TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. +## We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index 70a0da846d..44a90b498c 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index 8a9d6e90c9..c1b5934773 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index 7c758e3a8d..27c3841709 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 78c28bc0b6..1597962589 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index b7320ba163..538e3232b0 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index 259f5036c8..d5f9f99787 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nise/conf.py b/docs/nise/conf.py index da0b5631e8..d0ce53d14d 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index e537628f55..222108915a 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index 07bf873ef1..1d6d57fd83 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -184,7 +184,5 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -# TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. -# We can probably just list all of the mappings (other than maybe the current module, I think) intersphinx_mapping = {'https://docs.python.org/': None} From 2a16b74dfe782db185bc06c64418e2f58a0b7d3d Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 12:53:59 -0500 Subject: [PATCH 18/31] Use api-specific start year for docs copyright date --- build/templates/conf.py.mako | 4 ++-- docs/nidcpower/conf.py | 1 - docs/nidigital/conf.py | 3 +-- docs/nidmm/conf.py | 1 - docs/nifgen/conf.py | 1 - docs/nimodinst/conf.py | 1 - docs/niscope/conf.py | 1 - docs/nise/conf.py | 3 +-- docs/niswitch/conf.py | 1 - docs/nitclk/conf.py | 3 +-- src/nidcpower/metadata/config_addon.py | 1 + src/nidigital/metadata/config_addon.py | 1 + src/nidmm/metadata/config_addon.py | 1 + src/nifgen/metadata/config_addon.py | 1 + src/nimodinst/metadata/config_addon.py | 1 + src/niscope/metadata/config_addon.py | 1 + src/nise/metadata/config_addon.py | 1 + src/niswitch/metadata/config_addon.py | 1 + src/nitclk/metadata/config_addon.py | 1 + 19 files changed, 14 insertions(+), 14 deletions(-) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index dc38030955..add5980e17 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -3,6 +3,7 @@ import datetime current_year = datetime.datetime.today().year config = template_parameters['metadata'].config +copyright_start_year = config['initial_release_year'] version = config['module_version'] api_name = f"{config['driver_name']} Python API" @@ -66,8 +67,7 @@ master_doc = 'index' # General information about the project. project = '${api_name}' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? -copyright = '2017-${current_year}, National Instruments Corporation' +copyright = '${copyright_start_year}-${current_year}, National Instruments Corporation' author = 'NI' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index 44a90b498c..ddc850898e 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-DCPower Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index c1b5934773..3b16d26407 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -55,8 +55,7 @@ # General information about the project. project = 'NI-Digital Pattern Driver Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? -copyright = '2017-2023, National Instruments Corporation' +copyright = '2019-2023, National Instruments Corporation' author = 'NI' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index 27c3841709..390ac93b04 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-DMM Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 1597962589..86b9221745 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-FGEN Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index 538e3232b0..8b85fc27b9 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-ModInst Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index d5f9f99787..3864257314 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-SCOPE Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/nise/conf.py b/docs/nise/conf.py index d0ce53d14d..8b0f88a8b0 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -55,8 +55,7 @@ # General information about the project. project = 'NI Switch Executive Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? -copyright = '2017-2023, National Instruments Corporation' +copyright = '2018-2023, National Instruments Corporation' author = 'NI' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index 222108915a..f5af8a4d92 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -55,7 +55,6 @@ # General information about the project. project = 'NI-SWITCH Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? copyright = '2017-2023, National Instruments Corporation' author = 'NI' diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index 1d6d57fd83..8edcafc5e7 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -55,8 +55,7 @@ # General information about the project. project = 'NI-TClk Python API' -# TODO(ni-jfitzger): Should we adjust the copyright start date based on the year each API was added? -copyright = '2017-2023, National Instruments Corporation' +copyright = '2019-2023, National Instruments Corporation' author = 'NI' # The version info for the project you're documenting, acts as replacement for diff --git a/src/nidcpower/metadata/config_addon.py b/src/nidcpower/metadata/config_addon.py index 3bd6b7af57..373e8ef21d 100644 --- a/src/nidcpower/metadata/config_addon.py +++ b/src/nidcpower/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q2', + 'initial_release_year': '2017', } diff --git a/src/nidigital/metadata/config_addon.py b/src/nidigital/metadata/config_addon.py index 55952b4ab3..8a8b358543 100644 --- a/src/nidigital/metadata/config_addon.py +++ b/src/nidigital/metadata/config_addon.py @@ -2,6 +2,7 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q2', + 'initial_release_year': '2019', 'custom_types': [ { 'ctypes_type': '', diff --git a/src/nidmm/metadata/config_addon.py b/src/nidmm/metadata/config_addon.py index a46a34a7b3..d2bb5e6b54 100644 --- a/src/nidmm/metadata/config_addon.py +++ b/src/nidmm/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q1.1', + 'initial_release_year': '2017', } diff --git a/src/nifgen/metadata/config_addon.py b/src/nifgen/metadata/config_addon.py index a46a34a7b3..d2bb5e6b54 100644 --- a/src/nifgen/metadata/config_addon.py +++ b/src/nifgen/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q1.1', + 'initial_release_year': '2017', } diff --git a/src/nimodinst/metadata/config_addon.py b/src/nimodinst/metadata/config_addon.py index 3bd6b7af57..373e8ef21d 100644 --- a/src/nimodinst/metadata/config_addon.py +++ b/src/nimodinst/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q2', + 'initial_release_year': '2017', } diff --git a/src/niscope/metadata/config_addon.py b/src/niscope/metadata/config_addon.py index daaad37515..744c7c217e 100644 --- a/src/niscope/metadata/config_addon.py +++ b/src/niscope/metadata/config_addon.py @@ -2,6 +2,7 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q1.1', + 'initial_release_year': '2017', 'custom_types': [ # Redundant, since waveform_info is also in the base config.py file. See issue 1495 (https://github.com/ni/nimi-python/issues/1495) { diff --git a/src/nise/metadata/config_addon.py b/src/nise/metadata/config_addon.py index ff803faf11..41062ea767 100644 --- a/src/nise/metadata/config_addon.py +++ b/src/nise/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q1', + 'initial_release_year': '2018', } diff --git a/src/niswitch/metadata/config_addon.py b/src/niswitch/metadata/config_addon.py index ff803faf11..cc78656853 100644 --- a/src/niswitch/metadata/config_addon.py +++ b/src/niswitch/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q1', + 'initial_release_year': '2017', } diff --git a/src/nitclk/metadata/config_addon.py b/src/nitclk/metadata/config_addon.py index 3bd6b7af57..f96db4c228 100644 --- a/src/nitclk/metadata/config_addon.py +++ b/src/nitclk/metadata/config_addon.py @@ -2,4 +2,5 @@ config_additional_config = { 'module_version': '1.4.5.dev0', 'latest_runtime_version_tested_against': '2023 Q2', + 'initial_release_year': '2019', } From aeee08d8aad2339bd8c3ad7fcdc95bac3905753d Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 15:00:01 -0500 Subject: [PATCH 19/31] FIgure out new release process and update build_release.py --- tools/build_release.py | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/tools/build_release.py b/tools/build_release.py index 6e740c300e..35507b7abb 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -1,8 +1,4 @@ # !python -# TODO(ni-jfitzger): update this file to work for individual package releases. -# Specifics: -# * update LATEST_RELEASE files: figure out for instructions if it neeeds to include driver name for a correct url in examples.rst, rather than just X.Y.Z -# * update "Create a release on GitHub" step instructions to be for each individual package releasing. We may need to name/tag releases differently. import argparse from configure_logging import configure_logging @@ -31,7 +27,7 @@ def main(): usage = """Release script Prereqs * Be able to build locally - * `pip install --upgrade twine tox` into whichever Python 2.7 you use to build + * `pip install --upgrade twine tox` into whichever Python 3 you use to build Steps * Build master to ensure it is in a good state and ready for release @@ -42,7 +38,14 @@ def main(): * Change the "Unreleased" header to the version of the release * Change [Unreleased] in TOC to the version of the release * Commit to branch - * Update contents of src//LATEST_RELEASE with the version of the release being created. + * Examine changes mentioned in the changelog for each releasing module and determine if a major or minor version bump is warranted, according to [semver rules](https://semver.org/) + * SEMVER Rules Summary + * MAJOR.MINOR.PATCH + * MAJOR: breaking changes + * MINOR: backward-compatible feature additions + * PATCH: backward-compatible bug fixes + * Manually update the MAJOR.MINOR.PATCH part of module versions in src//metadata/config_addon.py as needed. + * For each module being released, update contents of src//LATEST_RELEASE to "-", where is the semantic version for the upcoming release. * `python3 tools/build_release.py --update --release` * This will update all the versions to remove any '.devN' * Commit to branch @@ -55,11 +58,13 @@ def main(): * `python3 tools/build_release.py --upload` * Upload to PyPI - you will need to type in your credentials * Merge the pull request to origin/master - * Create a release on GitHub using the portion from the changelog for this release for the description - * Add the ZIP files under `generated/examples` for each module as a release artifact. + * For each package that you are releasing: + * Create a release on GitHub using the portion from the changelog for this release for the description + * Add the ZIP files under `generated/examples` for the module as a release artifact. + * Tag: - * Create and checkout another branch for post-release changes * `python3 tools/build_release.py --update` - * This will update the version to X.X.(N+1).dev0 + * This will update the version to X.X.(N+1).dev0 for each module * Commit to branch * `python3 tools/build_release.py --build` * Clean and Build to update generated files From 0cfc4a9e8f138d8db220876cd81a7158dc616f44 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 17:26:26 -0500 Subject: [PATCH 20/31] Undo all build_release.py changes --- tools/build_release.py | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/tools/build_release.py b/tools/build_release.py index 35507b7abb..3720877d1d 100644 --- a/tools/build_release.py +++ b/tools/build_release.py @@ -27,7 +27,7 @@ def main(): usage = """Release script Prereqs * Be able to build locally - * `pip install --upgrade twine tox` into whichever Python 3 you use to build + * `pip install --upgrade twine tox` into whichever Python 2.7 you use to build Steps * Build master to ensure it is in a good state and ready for release @@ -38,14 +38,7 @@ def main(): * Change the "Unreleased" header to the version of the release * Change [Unreleased] in TOC to the version of the release * Commit to branch - * Examine changes mentioned in the changelog for each releasing module and determine if a major or minor version bump is warranted, according to [semver rules](https://semver.org/) - * SEMVER Rules Summary - * MAJOR.MINOR.PATCH - * MAJOR: breaking changes - * MINOR: backward-compatible feature additions - * PATCH: backward-compatible bug fixes - * Manually update the MAJOR.MINOR.PATCH part of module versions in src//metadata/config_addon.py as needed. - * For each module being released, update contents of src//LATEST_RELEASE to "-", where is the semantic version for the upcoming release. + * Update contents of LATEST_RELEASE with the version of the release being created. * `python3 tools/build_release.py --update --release` * This will update all the versions to remove any '.devN' * Commit to branch @@ -58,13 +51,11 @@ def main(): * `python3 tools/build_release.py --upload` * Upload to PyPI - you will need to type in your credentials * Merge the pull request to origin/master - * For each package that you are releasing: - * Create a release on GitHub using the portion from the changelog for this release for the description - * Add the ZIP files under `generated/examples` for the module as a release artifact. - * Tag: - + * Create a release on GitHub using the portion from the changelog for this release for the description + * Add the ZIP files under `generated/examples` for each module as a release artifact. * Create and checkout another branch for post-release changes * `python3 tools/build_release.py --update` - * This will update the version to X.X.(N+1).dev0 for each module + * This will update the version to X.X.(N+1).dev0 * Commit to branch * `python3 tools/build_release.py --build` * Clean and Build to update generated files From ea3c268f66e001185831f54c92fbb37879660e45 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 21:48:13 -0500 Subject: [PATCH 21/31] Add .readthedocs.yaml - Gives us better control over how documentation is built. - Allows contributors who don't have the readthedocs maintenance permission to update the configuration (with permission from repo maintainers) --- build/defines.mak | 1 + build/rules.mak | 6 ++- build/templates/.readthedocs.yaml.mako | 60 ++++++++++++++++++++++++++ docs/nidcpower/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nidigital/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nidmm/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nifgen/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nimodinst/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/niscope/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nise/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/niswitch/.readthedocs.yaml | 51 ++++++++++++++++++++++ docs/nitclk/.readthedocs.yaml | 51 ++++++++++++++++++++++ src/nidcpower/nidcpower.mak | 1 + src/nidigital/nidigital.mak | 1 + src/nidmm/nidmm.mak | 1 + src/nifgen/nifgen.mak | 2 +- src/nimodinst/nimodinst.mak | 1 + src/niscope/niscope.mak | 1 + src/nise/nise.mak | 1 + src/niswitch/niswitch.mak | 1 + src/nitclk/nitclk.mak | 1 + 21 files changed, 534 insertions(+), 2 deletions(-) create mode 100644 build/templates/.readthedocs.yaml.mako create mode 100644 docs/nidcpower/.readthedocs.yaml create mode 100644 docs/nidigital/.readthedocs.yaml create mode 100644 docs/nidmm/.readthedocs.yaml create mode 100644 docs/nifgen/.readthedocs.yaml create mode 100644 docs/nimodinst/.readthedocs.yaml create mode 100644 docs/niscope/.readthedocs.yaml create mode 100644 docs/nise/.readthedocs.yaml create mode 100644 docs/niswitch/.readthedocs.yaml create mode 100644 docs/nitclk/.readthedocs.yaml diff --git a/build/defines.mak b/build/defines.mak index 53585a466d..e261c36eea 100644 --- a/build/defines.mak +++ b/build/defines.mak @@ -90,6 +90,7 @@ DEFAULT_RST_FILES_TO_GENERATE := \ ) \ DEFAULT_SPHINX_CONF_PY := $(DRIVER_DOCS_DIR)/conf.py +DEFAULT_READTHEDOCS_CONFIG := $(DRIVER_DOCS_DIR)/.readthedocs.yaml # Files for tracking parts of the build SDIST_WHEEL_BUILD_DONE := $(LOG_DIR)/sdist_wheel_build_done diff --git a/build/rules.mak b/build/rules.mak index 0de9c7134e..4fc10ce353 100644 --- a/build/rules.mak +++ b/build/rules.mak @@ -92,6 +92,10 @@ $(SPHINX_CONF_PY): $(TEMPLATE_DIR)/conf.py.mako $(BUILD_HELPER_SCRIPTS) $(METADA $(call trace_to_console, "Generating",$@) $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) +$(READTHEDOCS_CONFIG): $(TEMPLATE_DIR)/.readthedocs.yaml.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES) + $(call trace_to_console, "Generating",$@) + $(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR))) + $(DRIVER_EXAMPLES_ZIP_FILE): $(EXAMPLE_FILES) $(call trace_to_console, "Zipping",$@) $(_hide_cmds)$(call log_command,cd src/$(DRIVER)/examples && zip -u -r -9 $@ * || ([ $$? -eq 12 ] && exit 0) || exit) @@ -107,7 +111,7 @@ clean: .PHONY: module doc_files sdist wheel installers module: $(MODULE_FILES) $(UNIT_TEST_FILES) -doc_files: $(RST_FILES) $(SPHINX_CONF_PY) +doc_files: $(RST_FILES) $(SPHINX_CONF_PY) $(READTHEDOCS_CONFIG) installers: sdist wheel $(UNIT_TEST_FILES): $(MODULE_FILES) diff --git a/build/templates/.readthedocs.yaml.mako b/build/templates/.readthedocs.yaml.mako new file mode 100644 index 0000000000..a450adc380 --- /dev/null +++ b/build/templates/.readthedocs.yaml.mako @@ -0,0 +1,60 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +<% + config = template_parameters['metadata'].config + module_name = config['module_name'] + # All of the files used to configure and build docs and readthedocs are in these 2 folders + build_trigger_paths = f'docs/_static/ docs/{module_name}/' + conf_py_path = f'docs/{module_name}/conf.py' +%>\ + +# 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: ${build_trigger_paths}. + # + # 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 -- ${build_trigger_paths}; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: ${conf_py_path} + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +## TODO(ni-jfitzger): Create requirements file for docs to make builds reproducible. See https://github.com/ni/nimi-python/issues/1968 +## Note: Our nimi-python readthedocs project used the defaults here: https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nidcpower/.readthedocs.yaml b/docs/nidcpower/.readthedocs.yaml new file mode 100644 index 0000000000..17d25ceb14 --- /dev/null +++ b/docs/nidcpower/.readthedocs.yaml @@ -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/nidcpower/. + # + # 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/nidcpower/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nidcpower/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nidigital/.readthedocs.yaml b/docs/nidigital/.readthedocs.yaml new file mode 100644 index 0000000000..345c1ddca5 --- /dev/null +++ b/docs/nidigital/.readthedocs.yaml @@ -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/nidigital/. + # + # 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/nidigital/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nidigital/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nidmm/.readthedocs.yaml b/docs/nidmm/.readthedocs.yaml new file mode 100644 index 0000000000..3e56209521 --- /dev/null +++ b/docs/nidmm/.readthedocs.yaml @@ -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/nidmm/. + # + # 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/nidmm/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nidmm/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nifgen/.readthedocs.yaml b/docs/nifgen/.readthedocs.yaml new file mode 100644 index 0000000000..6db88d414c --- /dev/null +++ b/docs/nifgen/.readthedocs.yaml @@ -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/nifgen/. + # + # 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/nifgen/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nifgen/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nimodinst/.readthedocs.yaml b/docs/nimodinst/.readthedocs.yaml new file mode 100644 index 0000000000..5d883fdd59 --- /dev/null +++ b/docs/nimodinst/.readthedocs.yaml @@ -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/nimodinst/. + # + # 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/nimodinst/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nimodinst/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/niscope/.readthedocs.yaml b/docs/niscope/.readthedocs.yaml new file mode 100644 index 0000000000..93ac020099 --- /dev/null +++ b/docs/niscope/.readthedocs.yaml @@ -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/niscope/. + # + # 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/niscope/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/niscope/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nise/.readthedocs.yaml b/docs/nise/.readthedocs.yaml new file mode 100644 index 0000000000..eb55952749 --- /dev/null +++ b/docs/nise/.readthedocs.yaml @@ -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/nise/. + # + # 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/nise/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nise/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/niswitch/.readthedocs.yaml b/docs/niswitch/.readthedocs.yaml new file mode 100644 index 0000000000..cb4f594d55 --- /dev/null +++ b/docs/niswitch/.readthedocs.yaml @@ -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/niswitch/. + # + # 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/niswitch/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/niswitch/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/nitclk/.readthedocs.yaml b/docs/nitclk/.readthedocs.yaml new file mode 100644 index 0000000000..cf943cec59 --- /dev/null +++ b/docs/nitclk/.readthedocs.yaml @@ -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/nitclk/. + # + # 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/nitclk/; + then + exit 183; + fi + +# Have ReadTheDocs build documentation with Sphinx +sphinx: + builder: html + configuration: docs/nitclk/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - epub + - pdf + +# Optionally declare the Python requirements required to build your docs +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/src/nidcpower/nidcpower.mak b/src/nidcpower/nidcpower.mak index bc7a1b0dd8..11f41d27d0 100644 --- a/src/nidcpower/nidcpower.mak +++ b/src/nidcpower/nidcpower.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) CUSTOM_TYPES_TO_COPY += \ lcr_load_compensation_spot.py \ diff --git a/src/nidigital/nidigital.mak b/src/nidigital/nidigital.mak index 1479b86590..ed238f1f3b 100644 --- a/src/nidigital/nidigital.mak +++ b/src/nidigital/nidigital.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) CUSTOM_TYPES_TO_COPY += \ history_ram_cycle_information.py \ diff --git a/src/nidmm/nidmm.mak b/src/nidmm/nidmm.mak index 72775b4eb5..874324a800 100644 --- a/src/nidmm/nidmm.mak +++ b/src/nidmm/nidmm.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nifgen/nifgen.mak b/src/nifgen/nifgen.mak index 24767081ea..010defb466 100644 --- a/src/nifgen/nifgen.mak +++ b/src/nifgen/nifgen.mak @@ -9,7 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) - +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nimodinst/nimodinst.mak b/src/nimodinst/nimodinst.mak index 1b4f3072c7..6d99daa012 100644 --- a/src/nimodinst/nimodinst.mak +++ b/src/nimodinst/nimodinst.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst enums.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/niscope/niscope.mak b/src/niscope/niscope.mak index d13cec8c88..2fb2b94cc7 100644 --- a/src/niscope/niscope.mak +++ b/src/niscope/niscope.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) CUSTOM_TYPES_TO_COPY += \ waveform_info.py \ diff --git a/src/nise/nise.mak b/src/nise/nise.mak index f89bf3ffb6..45a9a6b5fd 100644 --- a/src/nise/nise.mak +++ b/src/nise/nise.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/niswitch/niswitch.mak b/src/niswitch/niswitch.mak index 8f3d9e027c..010defb466 100644 --- a/src/niswitch/niswitch.mak +++ b/src/niswitch/niswitch.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(DEFAULT_RST_FILES_TO_GENERATE) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak diff --git a/src/nitclk/nitclk.mak b/src/nitclk/nitclk.mak index 28af09b5bd..139b836058 100644 --- a/src/nitclk/nitclk.mak +++ b/src/nitclk/nitclk.mak @@ -9,6 +9,7 @@ MODULE_FILES_TO_COPY := $(DEFAULT_PY_FILES_TO_COPY) RST_FILES_TO_GENERATE := $(filter-out rep_caps.rst enums.rst,$(DEFAULT_RST_FILES_TO_GENERATE)) SPHINX_CONF_PY := $(DEFAULT_SPHINX_CONF_PY) +READTHEDOCS_CONFIG := $(DEFAULT_READTHEDOCS_CONFIG) include $(BUILD_HELPER_DIR)/rules.mak From 688ef4aa85d9b1ff314147ae0a307bed4b0f6d1c Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 21:56:29 -0500 Subject: [PATCH 22/31] Restore original conf.py until we've updated the documentation for the original ReadTheDocs projct. --- docs/conf.py | 186 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000..42de409c36 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,186 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# NI Modular Instruments Python API documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 14 13:04:36 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../generated')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'NI Modular Instruments Python API' +copyright = '2017-2023, National Instruments Corporation' +author = 'NI' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '1.4.5.dev0' +# The short X.Y version. +version = release[:3] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'navigation_depth': -1, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Fix wide tables of RTD per https://github.com/rtfd/sphinx_rtd_theme/issues/117#issuecomment-41571653 +def setup(app): + app.add_css_file('theme_overrides.css') + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NIModularInstrumentsPythonAPIdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NIModularInstrumentsPythonAPI.tex', 'NI Modular Instruments Python API Documentation', + 'NI', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nimodularinstrumentspythonapi', 'NI Modular Instruments Python API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NIModularInstrumentsPythonAPI', 'NI Modular Instruments Python API Documentation', + author, 'NIModularInstrumentsPythonAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} From 700e6db16866d13474947bf0bee26dfada7bc1e1 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 12 May 2023 22:13:04 -0500 Subject: [PATCH 23/31] Update the original index.rst to help users find documentation --- docs/index.rst | 64 ++++++++++++++++++++------------------------------ 1 file changed, 25 insertions(+), 39 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 1f8083465e..4b3d8c0a68 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,44 +3,30 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -NI Modular Instruments Python Documentation +NI Modular Instruments Python Documentation Redirect ============================================================ -.. include:: _static/about.inc - -.. include:: _static/installation.inc - -.. include:: _static/contributing.inc - -.. include:: _static/support.inc - -.. include:: _static/documentation.inc - -Additional Documentation ------------------------- - -Refer to your driver documentation for device-specific information and detailed API documentation. - - -.. include:: _static/license.inc - -.. toctree:: - :maxdepth: 3 - :caption: Drivers - - nidcpower - nidigital - nidmm - nifgen - niscope - niswitch - nise - nimodinst - nitclk - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Documentation for versions 1.4.4 and earlier of the following modules can be found here: + +* nidcpower +* nidigital +* nidmm +* nifgen +* nimodinst +* niscope +* niswitch +* nise +* nitclk + +Simply select the version you wish to view documentation for. +For newer documentation, refer to the individual ReadTheDocs projects. + +* `nidcpower `_ +* `nidigital `_ +* `nidmm `_ +* `nifgen `_ +* `nimodinst `_ +* `niscope `_ +* `nise `_ +* `niswitch `_ +* `nitclk `_ From b3f3a39d4dc59b186677eec2d35e99279716bf79 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Sat, 13 May 2023 07:39:28 -0500 Subject: [PATCH 24/31] don't delete docs/conf.py during clean; we no longer codegen it --- build/Makefile | 1 - 1 file changed, 1 deletion(-) diff --git a/build/Makefile b/build/Makefile index a177970490..7903af227b 100644 --- a/build/Makefile +++ b/build/Makefile @@ -79,7 +79,6 @@ clean: start -$(_hide_cmds)rm $(foreach d,$(DRIVERS), $(ROOT_DIR)/docs/$(d)/*) $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)rm -Rf $(ROOT_DIR)/.coverage $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)rm -Rf $(ROOT_DIR)/README.rst $(SUPPRESS_ERROR_OUTPUT) ||: - -$(_hide_cmds)rm -Rf $(ROOT_DIR)/docs/conf.py $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)mkdir $(GENERATED_DIR) $(SUPPRESS_ERROR_OUTPUT) ||: start: From abb64b2928f8c5b24cc6a624278713f1dfe8e0ce Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Sat, 13 May 2023 07:45:39 -0500 Subject: [PATCH 25/31] Update clean recipe to also delete .readthedocs.yaml Any codegen'd file should be delete by make clean --- build/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/build/Makefile b/build/Makefile index 7903af227b..3f3d51755e 100644 --- a/build/Makefile +++ b/build/Makefile @@ -77,6 +77,7 @@ clean: start -$(_hide_cmds)find $(ROOT_DIR)/build -name __pycache__ -exec rmdir {} \; $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)find $(ROOT_DIR)/build -name '*.pyc' -exec rm {} \; $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)rm $(foreach d,$(DRIVERS), $(ROOT_DIR)/docs/$(d)/*) $(SUPPRESS_ERROR_OUTPUT) ||: + -$(_hide_cmds)rm $(foreach d,$(DRIVERS), $(ROOT_DIR)/docs/$(d)/.readthedocs.yaml) $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)rm -Rf $(ROOT_DIR)/.coverage $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)rm -Rf $(ROOT_DIR)/README.rst $(SUPPRESS_ERROR_OUTPUT) ||: -$(_hide_cmds)mkdir $(GENERATED_DIR) $(SUPPRESS_ERROR_OUTPUT) ||: From 87d893ced09539fee493893e30ebb9bf29471a0b Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Sat, 13 May 2023 08:13:08 -0500 Subject: [PATCH 26/31] For new projects, add link to original project. --- build/templates/index.rst.mako | 1 + docs/nidcpower/index.rst | 1 + docs/nidigital/index.rst | 1 + docs/nidmm/index.rst | 1 + docs/nifgen/index.rst | 1 + docs/nimodinst/index.rst | 1 + docs/niscope/index.rst | 1 + docs/nise/index.rst | 1 + docs/niswitch/index.rst | 1 + docs/nitclk/index.rst | 1 + 10 files changed, 10 insertions(+) diff --git a/build/templates/index.rst.mako b/build/templates/index.rst.mako index f41073ab6b..3ef5816b50 100644 --- a/build/templates/index.rst.mako +++ b/build/templates/index.rst.mako @@ -25,6 +25,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nidcpower/index.rst b/docs/nidcpower/index.rst index 1a55e4c3fe..5c72b0f391 100644 --- a/docs/nidcpower/index.rst +++ b/docs/nidcpower/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nidigital/index.rst b/docs/nidigital/index.rst index d13e60052e..75bcf63112 100644 --- a/docs/nidigital/index.rst +++ b/docs/nidigital/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nidmm/index.rst b/docs/nidmm/index.rst index bc258f0bbc..01f44e9dd7 100644 --- a/docs/nidmm/index.rst +++ b/docs/nidmm/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nifgen/index.rst b/docs/nifgen/index.rst index 08838a63c1..fd67e8429c 100644 --- a/docs/nifgen/index.rst +++ b/docs/nifgen/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nimodinst/index.rst b/docs/nimodinst/index.rst index e96e01bdc5..791b393f3d 100644 --- a/docs/nimodinst/index.rst +++ b/docs/nimodinst/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/niscope/index.rst b/docs/niscope/index.rst index 3a9383da32..aec178f777 100644 --- a/docs/niscope/index.rst +++ b/docs/niscope/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nise/index.rst b/docs/nise/index.rst index 30c55bbc32..3d27103ec9 100644 --- a/docs/nise/index.rst +++ b/docs/nise/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/niswitch/index.rst b/docs/niswitch/index.rst index 522da2c1bd..79b6644b63 100644 --- a/docs/niswitch/index.rst +++ b/docs/niswitch/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc diff --git a/docs/nitclk/index.rst b/docs/nitclk/index.rst index d28b323189..06670400a2 100644 --- a/docs/nitclk/index.rst +++ b/docs/nitclk/index.rst @@ -19,6 +19,7 @@ Additional Documentation Refer to your driver documentation for device-specific information and detailed API documentation. +Refer to the `nimi-python Read the Docs project `_ for documentation of versions 1.4.4 of the module or earlier. .. include:: ../_static/license.inc From c90c81cdab3e9c9af9e2b70a479b1b86a0bc00c9 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Sat, 13 May 2023 08:32:55 -0500 Subject: [PATCH 27/31] Update intersphinx_mapping format --- build/templates/conf.py.mako | 3 +-- docs/nidcpower/conf.py | 3 +-- docs/nidigital/conf.py | 3 +-- docs/nidmm/conf.py | 3 +-- docs/nifgen/conf.py | 3 +-- docs/nimodinst/conf.py | 3 +-- docs/niscope/conf.py | 3 +-- docs/nise/conf.py | 3 +-- docs/niswitch/conf.py | 3 +-- docs/nitclk/conf.py | 3 +-- 10 files changed, 10 insertions(+), 20 deletions(-) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index add5980e17..f71cbc161c 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -197,5 +197,4 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. ## TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. ## We can probably just list all of the mappings (other than maybe the current module, I think) -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index ddc850898e..287db9e816 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index 3b16d26407..1813adb369 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index 390ac93b04..116d6109d0 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 86b9221745..71070bb491 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index 8b85fc27b9..3c9362d3c6 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index 3864257314..8518d14bbc 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nise/conf.py b/docs/nise/conf.py index 8b0f88a8b0..630f49fa59 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index f5af8a4d92..14a72a0119 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index 8edcafc5e7..fe7e247c5f 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -183,5 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file From 5b769804cffdf64e55cdc9e770495008f489ad08 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Sat, 13 May 2023 11:08:56 -0500 Subject: [PATCH 28/31] Fix "Read the Docs" spelling --- README.rst | 2 +- build/templates/.readthedocs.yaml.mako | 2 +- docs/_static/installation.inc | 2 +- docs/index.rst | 3 ++- docs/nidcpower/.readthedocs.yaml | 2 +- docs/nidigital/.readthedocs.yaml | 2 +- docs/nidmm/.readthedocs.yaml | 2 +- docs/nifgen/.readthedocs.yaml | 2 +- docs/nimodinst/.readthedocs.yaml | 2 +- docs/niscope/.readthedocs.yaml | 2 +- docs/nise/.readthedocs.yaml | 2 +- docs/niswitch/.readthedocs.yaml | 2 +- docs/nitclk/.readthedocs.yaml | 2 +- 13 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 1ee45d3a42..29d8991f15 100644 --- a/README.rst +++ b/README.rst @@ -419,7 +419,7 @@ NI-TClk Python API Status Installation ============ -Driver specific installation instructions can be found on Read The Docs: +Driver specific installation instructions can be found on **Read the Docs**: * `nidcpower `_ * `nidigital `_ diff --git a/build/templates/.readthedocs.yaml.mako b/build/templates/.readthedocs.yaml.mako index a450adc380..3995569c8b 100644 --- a/build/templates/.readthedocs.yaml.mako +++ b/build/templates/.readthedocs.yaml.mako @@ -42,7 +42,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: ${conf_py_path} diff --git a/docs/_static/installation.inc b/docs/_static/installation.inc index f8ab642361..a7935e37a2 100644 --- a/docs/_static/installation.inc +++ b/docs/_static/installation.inc @@ -3,7 +3,7 @@ Installation ============ -Driver specific installation instructions can be found on Read The Docs: +Driver specific installation instructions can be found on **Read the Docs**: * `nidcpower `_ * `nidigital `_ diff --git a/docs/index.rst b/docs/index.rst index 4b3d8c0a68..611c7007e7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,7 +19,8 @@ Documentation for versions 1.4.4 and earlier of the following modules can be fou * nitclk Simply select the version you wish to view documentation for. -For newer documentation, refer to the individual ReadTheDocs projects. + +For newer documentation, refer to the individual **Read the Docs** projects. * `nidcpower `_ * `nidigital `_ diff --git a/docs/nidcpower/.readthedocs.yaml b/docs/nidcpower/.readthedocs.yaml index 17d25ceb14..6ddf4326c5 100644 --- a/docs/nidcpower/.readthedocs.yaml +++ b/docs/nidcpower/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nidcpower/conf.py diff --git a/docs/nidigital/.readthedocs.yaml b/docs/nidigital/.readthedocs.yaml index 345c1ddca5..78d424af53 100644 --- a/docs/nidigital/.readthedocs.yaml +++ b/docs/nidigital/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nidigital/conf.py diff --git a/docs/nidmm/.readthedocs.yaml b/docs/nidmm/.readthedocs.yaml index 3e56209521..b9cb50d33e 100644 --- a/docs/nidmm/.readthedocs.yaml +++ b/docs/nidmm/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nidmm/conf.py diff --git a/docs/nifgen/.readthedocs.yaml b/docs/nifgen/.readthedocs.yaml index 6db88d414c..18118ab79e 100644 --- a/docs/nifgen/.readthedocs.yaml +++ b/docs/nifgen/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nifgen/conf.py diff --git a/docs/nimodinst/.readthedocs.yaml b/docs/nimodinst/.readthedocs.yaml index 5d883fdd59..c3c16f748b 100644 --- a/docs/nimodinst/.readthedocs.yaml +++ b/docs/nimodinst/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nimodinst/conf.py diff --git a/docs/niscope/.readthedocs.yaml b/docs/niscope/.readthedocs.yaml index 93ac020099..58499e06f8 100644 --- a/docs/niscope/.readthedocs.yaml +++ b/docs/niscope/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/niscope/conf.py diff --git a/docs/nise/.readthedocs.yaml b/docs/nise/.readthedocs.yaml index eb55952749..722de91339 100644 --- a/docs/nise/.readthedocs.yaml +++ b/docs/nise/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nise/conf.py diff --git a/docs/niswitch/.readthedocs.yaml b/docs/niswitch/.readthedocs.yaml index cb4f594d55..96c691d4c5 100644 --- a/docs/niswitch/.readthedocs.yaml +++ b/docs/niswitch/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/niswitch/conf.py diff --git a/docs/nitclk/.readthedocs.yaml b/docs/nitclk/.readthedocs.yaml index cf943cec59..e5bddcd437 100644 --- a/docs/nitclk/.readthedocs.yaml +++ b/docs/nitclk/.readthedocs.yaml @@ -35,7 +35,7 @@ build: exit 183; fi -# Have ReadTheDocs build documentation with Sphinx +# Have Read the Docs build documentation with Sphinx sphinx: builder: html configuration: docs/nitclk/conf.py From ffeeadc794bf1e30e4dd0f07b1fd660078a6c2fd Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 2 Jun 2023 15:06:00 -0500 Subject: [PATCH 29/31] lead with spaces on continued lines in modified GNU Make recipes --- build/Makefile | 16 ++++++++-------- build/rules.mak | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/build/Makefile b/build/Makefile index 3f3d51755e..7306b2bb71 100644 --- a/build/Makefile +++ b/build/Makefile @@ -146,14 +146,14 @@ endef $(ROOT_DIR)/README.rst: $(GLOBAL_FILES_STARTED_FILE) $(call trace_to_console, "Creating Root",$(notdir $@)) $(_hide_cmds)$(call global_log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \ - $(STATIC_DOCS_DIR)/about.inc \ - $(DOCS_DIR)/*/status.inc \ - $(STATIC_DOCS_DIR)/installation.inc \ - $(STATIC_DOCS_DIR)/contributing.inc \ - $(STATIC_DOCS_DIR)/nidmm_usage.inc \ - $(STATIC_DOCS_DIR)/support.inc \ - $(STATIC_DOCS_DIR)/documentation.inc \ - $(STATIC_DOCS_DIR)/license.inc > $@) + $(STATIC_DOCS_DIR)/about.inc \ + $(DOCS_DIR)/*/status.inc \ + $(STATIC_DOCS_DIR)/installation.inc \ + $(STATIC_DOCS_DIR)/contributing.inc \ + $(STATIC_DOCS_DIR)/nidmm_usage.inc \ + $(STATIC_DOCS_DIR)/support.inc \ + $(STATIC_DOCS_DIR)/documentation.inc \ + $(STATIC_DOCS_DIR)/license.inc > $@) # Any step that any driver build does that would invalidate unit testing, flake8 or generated html # needs to delete this file. This will trigger a tox run. diff --git a/build/rules.mak b/build/rules.mak index 4fc10ce353..25c078d79c 100644 --- a/build/rules.mak +++ b/build/rules.mak @@ -142,14 +142,14 @@ else $(README): $(RST_FILES) $(wildcard $(STATIC_DOCS_DIR)/*) $(call trace_to_console, "Creating",$@) $(_hide_cmds)$(call log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \ - $(STATIC_DOCS_DIR)/about.inc \ - $(DRIVER_DOCS_DIR)/status.inc \ - $(DRIVER_DOCS_DIR)/installation.inc \ - $(STATIC_DOCS_DIR)/contributing.inc \ - $(STATIC_DOCS_DIR)/$(DRIVER)_usage.inc \ - $(STATIC_DOCS_DIR)/support.inc \ - $(STATIC_DOCS_DIR)/documentation.inc \ - $(STATIC_DOCS_DIR)/license.inc > $@) + $(STATIC_DOCS_DIR)/about.inc \ + $(DRIVER_DOCS_DIR)/status.inc \ + $(DRIVER_DOCS_DIR)/installation.inc \ + $(STATIC_DOCS_DIR)/contributing.inc \ + $(STATIC_DOCS_DIR)/$(DRIVER)_usage.inc \ + $(STATIC_DOCS_DIR)/support.inc \ + $(STATIC_DOCS_DIR)/documentation.inc \ + $(STATIC_DOCS_DIR)/license.inc > $@) endif From 449bd1c8dfc7e9efc4f12873917726462a7219c0 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 2 Jun 2023 15:06:55 -0500 Subject: [PATCH 30/31] Add empty line to end of conf.py --- build/templates/conf.py.mako | 2 +- docs/nidcpower/conf.py | 2 +- docs/nidigital/conf.py | 2 +- docs/nidmm/conf.py | 2 +- docs/nifgen/conf.py | 2 +- docs/nimodinst/conf.py | 2 +- docs/niscope/conf.py | 2 +- docs/nise/conf.py | 2 +- docs/niswitch/conf.py | 2 +- docs/nitclk/conf.py | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/build/templates/conf.py.mako b/build/templates/conf.py.mako index f71cbc161c..28363120e6 100644 --- a/build/templates/conf.py.mako +++ b/build/templates/conf.py.mako @@ -197,4 +197,4 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. ## TODO(ni-jfitzger): Add mappings for nimi-python APIs that reference other nimi-python APIs. ## We can probably just list all of the mappings (other than maybe the current module, I think) -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py index 287db9e816..21572832e6 100644 --- a/docs/nidcpower/conf.py +++ b/docs/nidcpower/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py index 1813adb369..fd39b29a07 100644 --- a/docs/nidigital/conf.py +++ b/docs/nidigital/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py index 116d6109d0..b0c95a809c 100644 --- a/docs/nidmm/conf.py +++ b/docs/nidmm/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py index 71070bb491..329d2970d7 100644 --- a/docs/nifgen/conf.py +++ b/docs/nifgen/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py index 3c9362d3c6..8622df08fe 100644 --- a/docs/nimodinst/conf.py +++ b/docs/nimodinst/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py index 8518d14bbc..b263f26ee2 100644 --- a/docs/niscope/conf.py +++ b/docs/niscope/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nise/conf.py b/docs/nise/conf.py index 630f49fa59..b9a2baafe2 100644 --- a/docs/nise/conf.py +++ b/docs/nise/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py index 14a72a0119..2b995b8461 100644 --- a/docs/niswitch/conf.py +++ b/docs/niswitch/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py index fe7e247c5f..232a5ff12b 100644 --- a/docs/nitclk/conf.py +++ b/docs/nitclk/conf.py @@ -183,4 +183,4 @@ def setup(app): ] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} \ No newline at end of file +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} From 0528f4b958b0d4107c5b85e45215d1f626dd3363 Mon Sep 17 00:00:00 2001 From: Jay Fitzgerald <34140133+ni-jfitzger@users.noreply.github.com> Date: Fri, 2 Jun 2023 15:53:43 -0500 Subject: [PATCH 31/31] Reword support.inc to not visibly mention nimi-python --- README.rst | 8 +++----- docs/_static/support.inc | 8 +++----- generated/nidcpower/README.rst | 8 +++----- generated/nidigital/README.rst | 8 +++----- generated/nidmm/README.rst | 8 +++----- generated/nifgen/README.rst | 8 +++----- generated/nimodinst/README.rst | 8 +++----- generated/niscope/README.rst | 8 +++----- generated/nise/README.rst | 8 +++----- generated/niswitch/README.rst | 8 +++----- generated/nitclk/README.rst | 8 +++----- 11 files changed, 33 insertions(+), 55 deletions(-) diff --git a/README.rst b/README.rst index 29d8991f15..222fa48b0e 100644 --- a/README.rst +++ b/README.rst @@ -456,22 +456,20 @@ The following is a basic example of using the **nidmm** module to open a session Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/docs/_static/support.inc b/docs/_static/support.inc index 1ab7f35675..62dc012a21 100644 --- a/docs/_static/support.inc +++ b/docs/_static/support.inc @@ -3,20 +3,18 @@ Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - diff --git a/generated/nidcpower/README.rst b/generated/nidcpower/README.rst index 979b094033..89ef08f916 100644 --- a/generated/nidcpower/README.rst +++ b/generated/nidcpower/README.rst @@ -160,22 +160,20 @@ The following is a basic example of using the **nidcpower** module to open a ses Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nidigital/README.rst b/generated/nidigital/README.rst index 3d7502474b..99bdfdccbe 100644 --- a/generated/nidigital/README.rst +++ b/generated/nidigital/README.rst @@ -170,22 +170,20 @@ source current, and measure both voltage and current using the PPMU on selected Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nidmm/README.rst b/generated/nidmm/README.rst index 4648284065..9467d10e12 100644 --- a/generated/nidmm/README.rst +++ b/generated/nidmm/README.rst @@ -139,22 +139,20 @@ The following is a basic example of using the **nidmm** module to open a session Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nifgen/README.rst b/generated/nifgen/README.rst index 53406b9b77..0c80fad4b0 100644 --- a/generated/nifgen/README.rst +++ b/generated/nifgen/README.rst @@ -142,22 +142,20 @@ The following is a basic example of using the **nifgen** module to open a sessio Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nimodinst/README.rst b/generated/nimodinst/README.rst index f42219f669..90f2f73489 100644 --- a/generated/nimodinst/README.rst +++ b/generated/nimodinst/README.rst @@ -139,22 +139,20 @@ The following is a basic example of using the **nimodinst** module to retrieve i Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/niscope/README.rst b/generated/niscope/README.rst index 2c381542a2..29b015f77f 100644 --- a/generated/niscope/README.rst +++ b/generated/niscope/README.rst @@ -228,22 +228,20 @@ The waveform_infos returned from `fetch_into `_ i Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nise/README.rst b/generated/nise/README.rst index 224caa6a45..a73f89d68c 100644 --- a/generated/nise/README.rst +++ b/generated/nise/README.rst @@ -138,22 +138,20 @@ The following is a basic example of using the **nise** module to open a session Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/niswitch/README.rst b/generated/niswitch/README.rst index 502ff12824..b1e1fedd58 100644 --- a/generated/niswitch/README.rst +++ b/generated/niswitch/README.rst @@ -138,22 +138,20 @@ The following is a basic example of using the **niswitch** module to open a sess Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: diff --git a/generated/nitclk/README.rst b/generated/nitclk/README.rst index d86e130612..b3a6f85447 100644 --- a/generated/nitclk/README.rst +++ b/generated/nitclk/README.rst @@ -136,22 +136,20 @@ The following is a basic example of using the **nitclk** module Support / Feedback ================== -The packages included in the **nimi-python** repository are supported by NI. For support, open -a request through the NI support portal at `ni.com `_. +For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_. +For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums `_. .. _bugs-section: Bugs / Feature Requests ======================= -To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the +To report a bug or submit a feature request specific to Python API, please use the `GitHub issues page `_. Fill in the issue template as completely as possible and we will respond as soon as we can. -For hardware support or any other questions not specific to this GitHub project, please visit `NI Community Forums `_. - .. _documentation-section: