Update HackRF docs links (#907)

* Update HackRF docs links

* Update new docs links

* Remove erroneous backticks

* update links

doc/Readme.md

@@ -1,6 +1,4 @@
-The primary source of documentation is the wiki on github:
+The primary source of documentation is on Read the Docs (https://hackrf.readthedocs.io/) or in the docs folder in the HackRF repository on GitHub (https://github.com/mossmann/hackrf/tree/master/docs). 
-
-https://github.com/mossmann/hackrf/wiki
 
 This directory contains supplemental documentation.
 

docs/source/conf.py

@@ -1,22 +1,3 @@
-# -*- coding: utf-8 -*-
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
 # -- Project information -----------------------------------------------------
 
 project = 'HackRF'
@@ -31,147 +12,21 @@ release = ''
 
 # -- General configuration ---------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
   'sphinx.ext.autodoc'
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 exclude_patterns = ['_build']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
-
-# The master toctree document.
 master_doc = 'index'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
 
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'sphinx_rtd_theme'
-html_static_path = ['static']
 html_css_files = ['status.css']
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
-# html_sidebars = {}
-
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'HackRFdoc'
-
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'HackRF.tex', 'HackRF Documentation',
-     'Great Scott Gadgets', 'manual'),
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'hackrf', 'HackRF Documentation',
-     [author], 1)
-]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'HackRF', 'HackRF Documentation',
-     author, 'HackRF', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-
-# -- Options for Epub output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']

docs/source/faq.rst

@@ -6,6 +6,8 @@ FAQ
 
 ----
 
+.. _faq_hackrf_under_linux:
+
 I can't seem to access my HackRF under Linux
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/source/getting_started_hackrf_gnuradio.rst

@@ -4,12 +4,14 @@ Getting Started with HackRF and GNU Radio
 
 We recommend getting started by watching the `Software Defined Radio with HackRF <https://greatscottgadgets.com/sdr/>`__ video series. This series will introduce you to HackRF One, software including GNU Radio, and teach you the fundamentals of Digital Signal Processing (DSP) needed to take full advantage of the power of Software Defined Radio (SDR). Additional helpful information follows.
 
+.. _try_pentoo:
+
 Try Your HackRF with Pentoo Linux
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The easiest way to get started with your HackRF and ensure that it works is to use Pentoo, a Linux distribution with full support for HackRF and GNU Radio. Download the latest Pentoo .iso image from one of the mirrors listed at `http://pentoo.ch/downloads/ <https://pentoo.ch/downloads>`__. Then burn the .iso to a DVD or use `UNetbootin <http://unetbootin.sourceforge.net/>`__ to install the .iso on a USB flash drive. Boot your computer using the DVD or USB flash drive to run Pentoo. Do this natively, not in a virtual machine. (Unfortunately high speed USB operation invariably fails when people try to run HackRF from a virtual machine.)
 
-Once Pentoo is running, you can immediately use it to `update firmware <https://github.com/mossmann/hackrf/wiki/Updating-Firmware>`__ on your HackRF or use other HackRF command line tools. For a walkthrough, watch `SDR with HackRF, Lesson 5: HackRF One <http://greatscottgadgets.com/sdr/5/>`__.
+Once Pentoo is running, you can immediately use it to :ref:`update firmware <updating_firmware>` on your HackRF or use other HackRF command line tools. For a walkthrough, watch `SDR with HackRF, Lesson 5: HackRF One <http://greatscottgadgets.com/sdr/5/>`__.
 
 To verify that your HackRF is detected, type ``hackrf_info`` at the command line. It should produce a few lines of output including "Found HackRF board." The 3V3, 1V8, RF, and USB LEDs should all be illuminated and are various colors.
 
@@ -28,7 +30,7 @@ As mentioned above, the best way to get started with HackRF is to use Pentoo Lin
 
 If your package manager includes the most recent release of libhackrf and gr-osmosdr, then use it to install those packages in addition to GNU Radio. Otherwise, the recommended way to install these tools is by using `PyBOMBS <https://github.com/gnuradio/pybombs>`__.
 
-See the `Operating System Tips <https://github.com/mossmann/hackrf/wiki/Operating-System-Tips>`__ page for information on setting up HackRF software on particular Operating Systems and Linux distributions.
+See the :ref:`Operating System Tips <operating_system_tips>` page for information on setting up HackRF software on particular Operating Systems and Linux distributions.
 
 If you have any trouble, make sure that things work when booted to Pentoo. This will allow you to easily determine if your problem is being caused by hardware or software, and it will give you a way to see how the software is supposed to function.
 

docs/source/multiple_device_hardware_synch.rst

@@ -108,7 +108,7 @@ Next we connect the *primary:P20-PIN7 ready* GPIO pin input to the *secondary:P2
 Upgrade
 ~~~~~~~
 
-Now that the hardware is setup, you need to upgrade your HackRFs' firmware, and your *libhackrf* to at least `v2017.02.1 <https://github.com/mossmann/hackrf/releases/tag/v2017.02.1>`__ as per `this wiki page <https://github.com/mossmann/hackrf/wiki/Updating-Firmware>`__.
+Now that the hardware is setup, you need to upgrade your HackRFs' firmware, and your *libhackrf* to at least `v2017.02.1 <https://github.com/mossmann/hackrf/releases/tag/v2017.02.1>`__ as per :ref:`this documentation page <updating_firmware>`.
 
 
 

docs/source/operating_system_tips.rst

@@ -1,3 +1,5 @@
+.. _operating_system_tips:
+
 ================================================
 Operating System Tips
 ================================================
@@ -115,7 +117,7 @@ Once you have the source downloaded, the host tools can be built as follows:
 	sudo make install
 	sudo ldconfig
 
-If you have HackRF hardware, you may need to `update the firmware <https://github.com/mossmann/hackrf/wiki/Updating-Firmware>`__ to match the host tools versions.
+If you have HackRF hardware, you may need to :ref:`update the firmware <updating_firmware>` to match the host tools versions.
 
 
 

docs/source/software_support.rst

@@ -9,7 +9,6 @@ This is intended to be a list of software known to work with the HackRF. There a
 
 
 
-
 GNU Radio Based
 ~~~~~~~~~~~~~~~
 
@@ -64,9 +63,9 @@ The first two tools (``hackrf_info`` and ``hackrf_transfer``) should cover most
 
     * **hackrf_si5351c** Read and write registers in the Silicon Labs Si5351C clock generator chip. This should also be unnecessary for most operation.
 
-    * **hackrf_spiflash** A tool to write new firmware to HackRF. This is mostly used for `Updating Firmware <https://github.com/mossmann/hackrf/wiki/Updating-Firmware>`__.
+    * **hackrf_spiflash** A tool to write new firmware to HackRF. This is mostly used for :ref:`Updating Firmware <updating_firmware>`.
 
-    * **hackrf_cpldjtag** A tool to update the CPLD on HackRF. This is needed only when `Updating Firmware <https://github.com/mossmann/hackrf/wiki/Updating-Firmware>`__ to a version prior to 2021.03.1.
+    * **hackrf_cpldjtag** A tool to update the CPLD on HackRF. This is needed only when :ref:`Updating Firmware <updating_firmware>` to a version prior to 2021.03.1.
 
 
 

docs/source/updating_firmware.rst

@@ -1,3 +1,5 @@
+.. _updating_firmware:
+
 ================================================
 Updating Firmware
 ================================================
@@ -6,7 +8,7 @@ HackRF devices ship with firmware on the SPI flash memory. The firmware can be u
 
 These instructions allow you to upgrade the firmware in order to take advantage of new features or bug fixes.
 
-If you have any difficulty making this process work from your native operating system, you can `use Pentoo or the GNU Radio Live DVD <https://github.com/mossmann/hackrf/wiki/Getting-Started-with-HackRF-and-GNU-Radio#try-your-hackrf-with-pentoo-linux>`__ to perform the updates.
+If you have any difficulty making this process work from your native operating system, you can  :ref:`use Pentoo or the GNU Radio Live DVD <try_pentoo>` to perform the updates.
 
 
 
@@ -27,7 +29,7 @@ When writing a firmware image to SPI flash, be sure to select firmware with a fi
 
 After writing the firmware to SPI flash, you may need to reset the HackRF device by pressing the RESET button or by unplugging it and plugging it back in.
 
-If you get an error that mentions HACKRF_ERROR_NOT_FOUND, check out the `FAQ <https://github.com/mossmann/hackrf/wiki/FAQ#i-cant-seem-to-access-my-hackrf-under-linux>`__. It's often a permissions problem that can be quickly solved.
+If you get an error that mentions HACKRF_ERROR_NOT_FOUND, check out the :ref:`FAQ <faq_hackrf_under_linux>`. It's often a permissions problem that can be quickly solved.
 
 
 

hardware/test/si5351-configure.py

@@ -33,12 +33,12 @@
 #   http://code.google.com/p/the-bus-pirate/
 #
 # This Si5351C configuration is a work in progress, it does not yet
-# implement the clock plan described in the HackRF wiki:
+# implement the clock plan described in the HackRF docs:
-# https://github.com/mossmann/hackrf/wiki/Clocking
+# https://hackrf.readthedocs.io/en/latest/clocking.html
 #
 # To follow progress in configuring the Si5351C, please refer to the
-# HackRF wiki:
+# HackRF docs:
-# https://github.com/mossmann/hackrf/wiki/Lemondrop-Bring-Up
+# https://hackrf.readthedocs.io/en/latest/lemondrop_bringup.html
 
 import sys