Skip to content

Commit 71d6c00

Browse files
ni-jfitzgerni-jfitzger
authored
Update the "About" and "Documentation" sections of individual READMEs (#1990)
* update about and documentation sections of indivdual readmes * Regenerate after merge * Generate about_driver.inc * Say module, rather than package, for consistency * Update emphasis, spacing, fix wording in a sentence
1 parent fa556a6 commit 71d6c00

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+310
-206
lines changed

‎README.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,5 +490,6 @@ licenses allow for non-commercial and commercial use.
490490

491491

492492
**gRPC Features**
493+
493494
For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is
494495
subject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).

‎build/defines.mak‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ DEFAULT_PY_FILES_TO_COPY := \
7575
_visatype.py \
7676

7777
DEFAULT_RST_FILES_TO_GENERATE := \
78+
about_$(DRIVER).inc \
7879
index.rst \
7980
$(DRIVER).rst \
8081
enums.rst \

‎build/rules.mak‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ $(DRIVER_DOCS_DIR)/%.inc: %.inc.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES)
8888
$(call trace_to_console, "Generating",$@)
8989
$(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR)))
9090

91+
$(DRIVER_DOCS_DIR)/about_$(DRIVER).inc: about_driver.inc.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES)
92+
$(call trace_to_console, "Generating",$@)
93+
$(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR), $(notdir $@)))
94+
9195
$(SPHINX_CONF_PY): $(TEMPLATE_DIR)/conf.py.mako $(BUILD_HELPER_SCRIPTS) $(METADATA_FILES)
9296
$(call trace_to_console, "Generating",$@)
9397
$(_hide_cmds)$(call log_command,$(call GENERATE_SCRIPT, $<, $(dir $@), $(METADATA_DIR)))
@@ -142,13 +146,13 @@ else
142146
$(README): $(RST_FILES) $(wildcard $(STATIC_DOCS_DIR)/*)
143147
$(call trace_to_console, "Creating",$@)
144148
$(_hide_cmds)$(call log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \
145-
$(STATIC_DOCS_DIR)/about.inc \
149+
$(DRIVER_DOCS_DIR)/about_$(DRIVER).inc \
146150
$(DRIVER_DOCS_DIR)/status.inc \
147151
$(DRIVER_DOCS_DIR)/installation.inc \
148152
$(STATIC_DOCS_DIR)/contributing.inc \
149153
$(STATIC_DOCS_DIR)/$(DRIVER)_usage.inc \
150154
$(STATIC_DOCS_DIR)/support.inc \
151-
$(STATIC_DOCS_DIR)/documentation.inc \
155+
$(STATIC_DOCS_DIR)/$(DRIVER)_documentation.inc \
152156
$(STATIC_DOCS_DIR)/license.inc > $@)
153157

154158
endif

‎build/templates/about_driver.inc.mako‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<%
2+
import build.helper as helper
3+
4+
config = template_parameters['metadata'].config
5+
module_name = config['module_name']
6+
driver_name = config['driver_name']
7+
%>\
8+
.. _about-section:
9+
10+
About
11+
=====
12+
13+
The **${module_name}** module provides a Python API for ${driver_name}. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
14+
15+
Support Policy
16+
--------------
17+
**${module_name}** supports all the Operating Systems supported by ${driver_name}.
18+
19+
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
20+

‎build/templates/index.rst.mako‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
${doc_header}
99
${"=" * len(doc_header)}
1010

11-
.. include:: ../_static/about_driver.inc
11+
.. include:: about_${module_name}.inc
1212

1313
.. include:: ../_static/contributing.inc
1414

‎build/templates/installation.inc.mako‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
Installation
2424
------------
2525

26-
As a prerequisite to using the ${module_name} module, you must install the ${driver_name} runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.
26+
As a prerequisite to using the **${module_name}** module, you must install the ${driver_name} runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.
2727

2828
The nimi-python modules (i.e. for **${driver_name}**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
2929

‎docs/_static/about_driver.inc‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎docs/_static/license.inc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ licenses allow for non-commercial and commercial use.
1010

1111

1212
**gRPC Features**
13+
1314
For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is
1415
subject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).

‎docs/_static/nidcpower_documentation.inc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _documentation-section:
2+
3+
Documentation
4+
=============
5+
6+
Documentation is available `here <http://nidcpower.readthedocs.io>`_.
7+
8+

‎docs/_static/nidigital_documentation.inc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _documentation-section:
2+
3+
Documentation
4+
=============
5+
6+
Documentation is available `here <http://nidigital.readthedocs.io>`_.
7+
8+

0 commit comments

Comments
 (0)