summaryrefslogtreecommitdiff
path: root/docs/sphinx/README
diff options
context:
space:
mode:
authorBen Reynwar2012-05-21 22:15:08 -0700
committerBen Reynwar2012-05-21 22:15:08 -0700
commitbc1b4c18c8f16b6fbc666593869547ad2529662f (patch)
treea56478024223260713e0601b1a2abe19ec11dd8e /docs/sphinx/README
parentf684f3c3997b973a914b3c1adffc3ba616f0f49b (diff)
downloadgnuradio-bc1b4c18c8f16b6fbc666593869547ad2529662f.tar.gz
gnuradio-bc1b4c18c8f16b6fbc666593869547ad2529662f.tar.bz2
gnuradio-bc1b4c18c8f16b6fbc666593869547ad2529662f.zip
docs: Fixing swig_doc and sphinx so that it can deal with 3.7 style.
Diffstat (limited to 'docs/sphinx/README')
-rw-r--r--docs/sphinx/README13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/sphinx/README b/docs/sphinx/README
index c3ac38264..0ae3a43f8 100644
--- a/docs/sphinx/README
+++ b/docs/sphinx/README
@@ -48,7 +48,7 @@ examples.
under the "Slicing and Dicing Streams" subheading.
Edit file gnuradio/docs/sphinx/source/gr/slicedice_blk.rst and add
the line
- >.. autoblock:: gnuradio.gr.myslicer
+ >.. autooldblock:: gnuradio.gr.myslicer
2) Adding a new python hierarchical block gnuradio.digital.mymod
Edit file gnruadio/docs/sphinx/source/digital/index.rst and add the
@@ -63,7 +63,10 @@ examples.
a python hierarchical signal processing block so that it can format
it appropriately.
-The process for documenting objects that are not signal processing blocks is
-similar but rather than using the 'autoblock' and 'autopyblock' directives
-the standard sphinx directives such as 'autofunction' and 'autoclass' can
-be used. \ No newline at end of file
+The process for documenting objects that are not signal processing
+blocks is similar but rather than using the 'autooldblock', and
+'autopyblock' directives the standard sphinx directives such as
+'autofunction' and 'autoclass' can be used.
+
+Finally for signal processing blocks using the 3.7 style the directive
+'autoblock' rather than 'autooldblock' can be used. \ No newline at end of file