hero123457/uhd
1
0
Fork 0
mirror of https://github.com/EttusResearch/uhd.git synced 2026-10-25 17:36:10 +00:00
Code Issues Projects Releases Wiki Activity

docs: Fix FPGA readme (Doxygen link)

Browse Source
This commit is contained in:
Martin Braun 2026-04-29 10:11:12 +02:00 committed by mkoop-ni
parent 9e603ed1d4
commit 4a3873123b
2 changed files with 3 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
fpga/README.md
View File

@ -46,12 +46,5 @@ command will do the right thing.
## Building This Manual
This FPGA manual is available on the web at http://files.ettus.com/manual/md_fpga.html for the most
recent stable version of UHD. If you wish to read documentation for a custom/unstable branch you will
need to build it and open it locally using a web browser. To do so please install
[Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html#srcbin) on your system and run the following commands:
$ cd docs
$ make
$ sensible-browser html/index.html
This FPGA manual is now fully integrated into the UHD manual and is built as
part of the UHD build process.

4
host/docs/installation/build.dox.in
View File

@ -122,13 +122,11 @@ general.
### Doxygen
- **Purpose:** generates HTML API documentation
- **Purpose:** generates HTML UHD manual
- **Minimum Recommended Version:** 1.8
- **Usage:** build time (optional)
- **Download URL:** http://www.doxygen.nl/download.html
- **Alternate method:** Install **setuptools**, and use the **easy_install** command to install Docutils. http://pypi.python.org/pypi/setuptools
### NSIS
- **Purpose:** create Windows installers. It is used to create binary packages of UHD enabling easy distribution and installation of UHD, associated utilities, and examples.