diff options
Diffstat (limited to 'gr-uhd/doc')
-rw-r--r-- | gr-uhd/doc/.gitignore | 2 | ||||
-rw-r--r-- | gr-uhd/doc/Makefile.am | 27 | ||||
-rw-r--r-- | gr-uhd/doc/README.uhd | 14 | ||||
-rw-r--r-- | gr-uhd/doc/uhd.dox | 35 |
4 files changed, 78 insertions, 0 deletions
diff --git a/gr-uhd/doc/.gitignore b/gr-uhd/doc/.gitignore new file mode 100644 index 000000000..b336cc7ce --- /dev/null +++ b/gr-uhd/doc/.gitignore @@ -0,0 +1,2 @@ +/Makefile +/Makefile.in diff --git a/gr-uhd/doc/Makefile.am b/gr-uhd/doc/Makefile.am new file mode 100644 index 000000000..eee3ebcf6 --- /dev/null +++ b/gr-uhd/doc/Makefile.am @@ -0,0 +1,27 @@ +# +# Copyright 2011 Free Software Foundation, Inc. +# +# This file is part of GNU Radio +# +# GNU Radio is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3, or (at your option) +# any later version. +# +# GNU Radio is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with GNU Radio; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. +# + +include $(top_srcdir)/Makefile.common + +SUBDIRS = + +dist_gr_doc_DATA = \ + README.uhd diff --git a/gr-uhd/doc/README.uhd b/gr-uhd/doc/README.uhd new file mode 100644 index 000000000..ec8024c09 --- /dev/null +++ b/gr-uhd/doc/README.uhd @@ -0,0 +1,14 @@ +This is the GNU Radio UHD package. It is the interface to the UHD +library to connect to and send and receive data between the Ettus +Research, LLC product line. To use the UHD blocks, the Python +namespaces is in gnuradio.uhd, which would be normally imported +as: + + from gnuradio import uhd + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + + help(uhd) + diff --git a/gr-uhd/doc/uhd.dox b/gr-uhd/doc/uhd.dox new file mode 100644 index 000000000..f08fe2f06 --- /dev/null +++ b/gr-uhd/doc/uhd.dox @@ -0,0 +1,35 @@ +/*! \page page_uhd UHD Interface + +\section Introduction +This is the GNU Radio UHD package. It is the interface to the UHD +library to connect to and send and receive data between the Ettus +Research, LLC product line. To use the UHD blocks, the Python +namespaces is in gnuradio.uhd, which would be normally imported +as: + +\code + from gnuradio import uhd +\endcode + +The relevant blocks are listed in the \ref uhd_blk group. + +A quick listing of the details can be found in Python after importing +by using: + +\code + help(uhd) +\endcode + + +\section External Documentation + +Ettus Research keeps the comprehensive documentation to the underlying UHD driver, which can be found: + + http://files.ettus.com/uhd_docs/manual/html/ + +The UHD Doxygen page is located: + + http://files.ettus.com/uhd_docs/doxygen/html/index.html + + +*/ |