[prev in list] [next in list] [prev in thread] [next in thread] 

List:       gnuradio-discuss
Subject:    [Discuss-gnuradio] Does anyone use the Sphinx (Python) Manual?
From:       Marc Lichtman <marcll () vt ! edu>
Date:       2019-01-31 16:37:35
Message-ID: CAJBfYq9fD9n8zjBGkTJABh__jXUAKumLz-Ct+a2wvL7TiE2V5A () mail ! gmail ! com
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]


Hey All,

We are attempting to migrate the useful Sphinx documentation into Doxygen
so there is less redundant documentation, and one less thing to deal with
in 3.8.  If you are someone who uses or has used the Sphinx manual, we
would appreciate feedback about what parts of it you use.  Hypothetically,
if it disappeared tomorrow, would you notice/care?  If you don't want to
reply on the mailing list feel free to email me directly, I appreciate any
feedback!

Personally, in the past I have used it for:

1) Seeing docs of in-tree Python blocks, nearly all of which are hier
blocks.  Although I usually just use the documentation tab within GRC.

2) Looking up the Python version of a function, like PMT/tags/msg related
stuff.  That being said, more often I just pull up the Usage Manual page
and jump to the example Python code.

-Marc

[Attachment #5 (text/html)]

<div dir="ltr"><div dir="ltr"><div>Hey All,<br></div><div dir="ltr"><br></div><div \
dir="ltr">We are attempting to migrate the useful Sphinx documentation into  Doxygen \
so there is less redundant documentation, and one less thing to deal with in 3.8.   \
If you are someone who uses or  has used the Sphinx manual, we would appreciate \
feedback about what  parts of it you use.   Hypothetically, if it disappeared \
tomorrow, would you notice/care?   If you don&#39;t want to reply on the mailing list \
feel free to email me directly, I appreciate any feedback!<br></div><div \
dir="ltr"><br></div><div>Personally, in the past I have used it for: \
<br></div><div><br></div><div>1) Seeing docs of in-tree Python blocks, nearly all of \
which are hier blocks.   Although I usually just use the documentation tab within \
GRC. <br></div><div><br></div><div>2) Looking up the Python version of a function, \
like PMT/tags/msg related stuff.   That being said, more often I just pull up the \
Usage Manual page and jump to the example Python code.   <br></div><div \
dir="ltr"><br></div><div>-Marc<br></div></div></div>



_______________________________________________
Discuss-gnuradio mailing list
Discuss-gnuradio@gnu.org
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio


[prev in list] [next in list] [prev in thread] [next in thread]