diff options
| author | Bogdan Radulescu <bogdan@nimblex.net> | 2018-02-03 13:30:58 +0100 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-02-03 13:30:58 +0100 |
| commit | 3c177dbe3b93dc9a5db27f9b53417a28a1ead6ad (patch) | |
| tree | f25c24b0d2127d0dc750e53e669e4d5c2e071116 /gr-blocks/docs | |
| parent | a0adcd3347c7ffd6ef3c42ce7705a23978774d3b (diff) | |
Rename subdir doc to docs where appropriate
This makes the subdir naming consistent across modules.
Diffstat (limited to 'gr-blocks/docs')
| -rw-r--r-- | gr-blocks/docs/CMakeLists.txt | 23 | ||||
| -rw-r--r-- | gr-blocks/docs/README.blocks | 12 | ||||
| -rw-r--r-- | gr-blocks/docs/blocks.dox | 24 |
3 files changed, 59 insertions, 0 deletions
diff --git a/gr-blocks/docs/CMakeLists.txt b/gr-blocks/docs/CMakeLists.txt new file mode 100644 index 0000000000..4e185fde06 --- /dev/null +++ b/gr-blocks/docs/CMakeLists.txt @@ -0,0 +1,23 @@ +# Copyright 2012 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. + +install( + FILES README.blocks + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-blocks/docs/README.blocks b/gr-blocks/docs/README.blocks new file mode 100644 index 0000000000..7b36898f2e --- /dev/null +++ b/gr-blocks/docs/README.blocks @@ -0,0 +1,12 @@ +This is the gr-blocks package. It contains the basic blocks that are +widely used in many different types of flowgraphs. To use these blocks, +the Python namespace is in gnuradio.blocks, which would be normally +imported as: + + from gnuradio import blocks + +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(blocks) diff --git a/gr-blocks/docs/blocks.dox b/gr-blocks/docs/blocks.dox new file mode 100644 index 0000000000..fb7d3e67ab --- /dev/null +++ b/gr-blocks/docs/blocks.dox @@ -0,0 +1,24 @@ +/*! \page page_blocks Standard GNU Radio Blocks + +\section blocks_introduction Introduction + +This is the gr-blocks package. It contains many of the generic, +standard, or simple blocks used for many aspects of building GNU Radio +flowgraphs. To use these blocks, the Python module is +gnuradio.blocks, which would be normally imported as: + +\code + from gnuradio import blocks +\endcode + +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: + +\code + help(blocks) +\endcode + +*/ |