GRC 3.3.0 block documentation missing

GNU Radio
#1

Hi list,

After reinstalling and upgrading the GNU Radio from version 3.2.2 to
3.3.0, on two different platforms, I have lost some of the valuable GRC
documentation which was available earlier in the blocks. Many of the
blocks now have much less (or none at all) information, and I need every
bit.

How is it possible to get the GRC block documentation back in ver. 3.3.0
?

Rickard

#2

On 10/29/10 10:42 AM, Rickard Nilsson wrote:

Hi list,

After reinstalling and upgrading the GNU Radio from version 3.2.2 to 3.3.0, on
two different platforms, I have lost some of the valuable GRC documentation which
was available earlier in the blocks. Many of the blocks now have much less (or
none at all) information, and I need every bit.

I’ve noticed this too. :frowning:

(^.^)@ Ed

#3

On 10/29/10 12:29 PM, Josh B. wrote:

Did you build and install the doxygen documentation?

I installed under OSX 10.6.4 using Michael D.’ macports
packaging of 3.3.0

Look at/etc/gnuradio/conf.d/grc.conf
Is there documentation in the directory specified by doc_dir?

No, there is not.

I did further checking, and there is no doxygen package installed.
Further, doing a search of all “gnuradio*” packages in the
repository showed nothing that looked like a documentation package.

Michael, is this an oversight, or am I missing something?

@(^.^)@ Ed

#4

On Oct 29, 2010, at 2:53 PM, Ed Criscuolo wrote:

I did further checking, and there is no doxygen package installed.
Further, doing a search of all “gnuradio*” packages in the
repository showed nothing that looked like a documentation package.

Michael, is this an oversight, or am I missing something?

I think it’s not an oversight; maybe it’s a feature? If you installed
GNU Radio via MacPorts’ “gnuradio” port (or “gnuradio-*”), you need to
do “sudo port install gnuradio +docs” to get the docs. I made them
separate because not everyone wants them & they do take extra time to be
created.

You (or someone) need to install “doxygen” to get documentation. Looks
like GNU Radio’s build system auto-magically, and quietly, disables
documentation if doxygen isn’t available (meaning, ‘configure’ says it
cannot find doxygen but ‘docs’ is still enabled in the list of
components to be build; the disabling comes when it is time to actually
build the docs). This should probably be fixed, since it is confusing.

It’s very straight forward to get documentation on OSX using MacPorts:

sudo port install doxygen

then re-run configure & make if you’re building from GIT. Hope this
helps! - MLD

#5

On 10/29/10 7:55 PM, Michael D. wrote:

I think it’s not an oversight; maybe it’s a feature? If you installed GNU Radio
via MacPorts’ “gnuradio” port (or “gnuradio-*”), you need to do “sudo port install
gnuradio +docs” to get the docs. I made them separate because not everyone wants
them& they do take extra time to be created.

You (or someone) need to install “doxygen” to get documentation. Looks like GNU
Radio’s build system auto-magically, and quietly, disables documentation if
doxygen isn’t available (meaning, ‘configure’ says it cannot find doxygen but
‘docs’ is still enabled in the list of components to be build; the disabling comes
when it is time to actually build the docs). This should probably be fixed, since
it is confusing.

It’s very straight forward to get documentation on OSX using MacPorts:

sudo port install doxygen

then re-run configure& make if you’re building from GIT. Hope this helps! -
MLD

Thanks Mike! That did the trick. I ran

“sudo port install doxygen”

followed by

“sudo port -f install gnuradio-companion +docs”

Had to use the “force” switch since gnuradio-companion was already
installed without the “-docs” variant, and install complains if
the variants don’t match.

Just for reference, I’m using OSX 10.6.4 on a 17" MacBook Pro,
installing GR 3.3.0 via MacPorts, and building everything
32-bit by default.

@(^.^)@ Ed

#6

Did you build and install the doxygen documentation?

Look at /etc/gnuradio/conf.d/grc.conf
Is there documentation in the directory specified by doc_dir?

-Josh