uhd/host/docs
Martin Braun 97160d6ade docs: Add shim Sphinx config for readthedocs
This adds a faux Sphinx project under host/docs. When invoking sphinx,
it will in fact forward the generator request to Doxygen. This is useful
for generating the UHD manual, e.g., on readthedocs.

To enable the latter service, .readthedocs.yaml and environment.yml
files were added as well.
2022-01-24 10:01:41 +01:00
..
res docs: x410: Document GPIO API and capabilities 2021-11-05 12:23:48 -07:00
sphinx docs: Add shim Sphinx config for readthedocs 2022-01-24 10:01:41 +01:00
build.dox.in docs: Align dependencies and bump deb package versions 2021-11-02 07:57:17 -07:00
c_api.dox uhd: Remove usage of time_t (except when required) 2018-08-20 16:56:43 -07:00
calibration.dox fpga: docs: Improve documentation of rx_frontend_gen3 2021-04-07 11:02:53 -05:00
capi.dox docs: Fix Doxygen warnings 2018-07-31 10:05:03 -07:00
CMakeLists.txt cmake: Replace CMAKE_{SOURCE,BINARY}_DIR with UHD_*_DIR 2021-09-10 15:08:10 -05:00
coding.dox docs: Improve documentation for properties and -propagation 2021-12-03 11:34:35 -08:00
compat.dox docs: Add manual page on compat numbers 2019-01-02 16:28:39 -08:00
configfiles.dox docs: Add comments on mpm.conf 2020-07-09 00:39:11 -07:00
configuration.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
converters.dox docs: Amended docs for conversion routines 2015-01-14 16:49:34 +01:00
dboards.dox uhd: Add support for the USRP X410 2021-06-10 12:01:53 -05:00
devices.dox docs: devices: remove child page relation to individual dboards 2021-06-23 12:24:57 -05:00
Doxyfile.in cmake: Replace CMAKE_{SOURCE,BINARY}_DIR with UHD_*_DIR 2021-09-10 15:08:10 -05:00
dpdk.dox docs: Update DPDK documentation 2021-12-06 13:22:03 -08:00
Ettus_Logo.png docs: Moved manual to Doxygen 2014-04-09 17:25:09 +02:00
general.dox docs: Improve language on threading for recv() and send() 2019-08-22 15:33:56 -07:00
gpio_api.dox docs: x410: Document GPIO API and capabilities 2021-11-05 12:23:48 -07:00
gpsdo_b2x0.dox docs: Comments on B2x0 + GPSDO 2016-09-27 17:08:41 -07:00
gpsdo_x3x0.dox docs: x300: Match GPSDO code examples to code, avoid Boost 2018-05-09 16:36:29 -07:00
gpsdo.dox docs: fixed links where original URL was not accessible anymore 2019-11-22 10:15:01 -08:00
group_defs.dox docs: Improve documentation for properties and -propagation 2021-12-03 11:34:35 -08:00
identification.dox docs: Major revisions and additions 2015-01-07 15:37:14 +01:00
images.dox Update ISE/Vivado versions in images.dox 2018-06-26 16:14:01 -07:00
install.dox docs: Align dependencies and bump deb package versions 2021-11-02 07:57:17 -07:00
logging.dox log: Added more comments and manual page 2017-04-20 13:38:41 -07:00
mainpage.dox cmake/doxygen: Fix FPGA manual post-FPGA-merge 2020-02-06 08:45:27 -06:00
mpm.dox python: multi_usrp: Add get_mpm_client() API call 2020-12-04 12:06:14 -08:00
multiple.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
ni_rio_kernel.dox docs: Update PCIe xport instructions for NI Repos 2020-07-20 16:01:50 -05:00
octoclock_firmware_burner.1 Updated master-specfic documentation 2014-07-31 10:49:40 -07:00
octoclock.dox Docs: Minor housekeeping 2016-10-21 10:05:23 -07:00
power.dox docs: Fix missing section header in power level controls page 2021-04-19 14:42:50 -05:00
properties.dox docs: Improve documentation for properties and -propagation 2021-12-03 11:34:35 -08:00
pythonapi.dox docs: Add Windows-specific UHD Python module notes 2020-09-03 11:49:12 -05:00
rd_testing.dox tests: updated devtest runner to use standard device args 2020-05-27 09:46:01 -05:00
rfnoc_docs.dox docs: Improve documentation for properties and -propagation 2021-12-03 11:34:35 -08:00
stream.dox docs: Amended docs for conversion routines 2015-01-14 16:49:34 +01:00
style.css pulled in some dboard docs and fixes 2010-04-22 12:55:54 -07:00
sync.dox docs: sync: Update page on synchronization 2021-09-16 11:30:02 -07:00
transport.dox docs: Add stream and transport args documentation 2020-04-13 11:49:39 -05:00
twinrx.dox TwinRX: Remove frontend filter 2021-04-08 08:48:18 -05:00
uhd_cal_rx_iq_balance.1 Updated documentation 2014-07-31 10:49:34 -07:00
uhd_cal_tx_dc_offset.1 Updated documentation 2014-07-31 10:49:34 -07:00
uhd_cal_tx_iq_balance.1 Updated documentation 2014-07-31 10:49:34 -07:00
uhd_config_info.1 Added uhd_config_info utility 2015-12-30 14:23:05 -08:00
uhd_find_devices.1 uhd: Removed drivers for E100/E110 2017-09-29 10:52:27 -07:00
uhd_image_loader.1 uhd: Removed drivers for E100/E110 2017-09-29 10:52:27 -07:00
uhd_images_downloader.1 Merge branch 'maint' 2014-08-01 18:11:52 +02:00
uhd_semvar.dox docs: Added section on UHD semantic versioning 2016-10-28 09:59:10 -07:00
uhd_usrp_probe.1 utils: Add RFNoC-specific features to uhd_usrp_probe 2019-11-26 12:16:25 -08:00
uhd.dox docs: Add page for the C API 2018-07-19 16:39:57 -07:00
usrp1.dox docs: Add Known Issues section to USRP1 manual page 2018-03-23 16:47:11 -07:00
usrp2_card_burner.1 Updated documentation 2014-07-31 10:49:34 -07:00
usrp2.dox docs: Add Known Issues section for USRP2/N2x0 2018-03-23 16:39:21 -07:00
usrp_b100.dox docs: Added Known Issues to B100 manual 2018-03-23 16:29:58 -07:00
usrp_b200.dox b200: Enable power calibration API 2020-06-03 15:14:01 -05:00
usrp_e1x0.dox docs: Updates to legacy devices, XCVR2450 2017-10-23 15:15:06 -07:00
usrp_e3xx.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
usrp_n2xx_simple_net_burner.1 Merge branch 'maint' 2014-08-01 18:11:52 +02:00
usrp_n3xx.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
usrp_x3x0_config.dox docs: fixed links where original URL was not accessible anymore 2019-11-22 10:15:01 -08:00
usrp_x3x0.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
usrp_x3xx_fpga_burner.1 docs: Some X3x0-related updates 2016-08-16 15:56:09 -07:00
usrp_x4xx.dox docs: Several minor manual improvements 2021-11-16 14:26:24 -08:00
vrt_chdr.dox docs: Add new CHDR format to transports 2020-09-11 00:44:25 -07:00
x400_gpio_api.dox docs: x410: Document GPIO API and capabilities 2021-11-05 12:23:48 -07:00
zbx.dox docs: x4xx: Update information on CPLD updating 2021-07-09 00:08:11 -07:00