Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zhindes committed Jan 24, 2022
1 parent a1843c3 commit ffe3fd6
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 218 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This is the MIT license: http://www.opensource.org/licenses/mit-license.php

Copyright (c) 2017, National Instruments Corp. NI-DAQ is a trademark of National
Copyright (c) 2022, National Instruments Corp. NI-DAQ is a trademark of National
Instruments.

Permission is hereby granted, free of charge, to any person obtaining a copy of this
Expand Down
15 changes: 3 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ This package was created and is supported by NI. The package is implemented as a
complex, highly object-oriented wrapper around the NI-DAQmx C API using the
`ctypes <https://docs.python.org/2/library/ctypes.html>`_ Python library.

**nidaqmx** 0.5 supports all versions of the NI-DAQmx driver that ships with the
C API. The C API is included in any version of the driver that supports it. The
**nidaqmx** supports all versions of the NI-DAQmx driver that ships with the C
API. The C API is included in any version of the driver that supports it. The
**nidaqmx** package does not require installation of the C header files.

Some functions in the **nidaqmx** package may be unavailable with earlier
Expand All @@ -23,7 +23,7 @@ NI-DAQmx.

**nidaqmx** supports only the Windows operating system.

**nidaqmx** supports CPython 2.7, 3.4+, PyPy2, and PyPy3.
**nidaqmx** supports CPython 3.7+ and PyPy3.

Installation
============
Expand All @@ -36,15 +36,6 @@ of NI-DAQmx.

$ python -m pip install nidaqmx

Or **easy_install** from
`setuptools <http://pypi.python.org/pypi/setuptools>`_::

$ python -m easy_install nidaqmx

You also can download the project source and run::

$ python setup.py install

.. _usage-section:

Usage
Expand Down
201 changes: 0 additions & 201 deletions docs/README.rst

This file was deleted.

7 changes: 4 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

# General information about the project.
project = u'NI-DAQmx Python API'
copyright = u'2017, National Instruments'
copyright = u'2022, National Instruments'
author = u'National Instruments'

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -58,8 +58,9 @@
#
# The short X.Y version.
version = u'0.5'
# The full version, including alpha/beta/rc tags.
release = u'0.5.0'
# The full version. Since we adhere to semver, there is no reason to make this
# more specific.
release = u'0.5'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
NI-DAQmx Python Documentation
=============================

.. include:: README.rst
.. include:: ../README.rst

.. toctree::
:maxdepth: 3
Expand Down

0 comments on commit ffe3fd6

Please sign in to comment.