Merge pull request #14 from straithe/docstransfer

Update docs to rtd

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,28 @@
+# -- Project information -----------------------------------------------------
+
+project = 'YARD Stick One'
+copyright = '2021, Great Scott Gadgets'
+author = 'Great Scott Gadgets'
+
+version = ''
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    'sphinx.ext.autodoc',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+source_suffix = '.rst'
+master_doc = 'index'
+language = None
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/enclosureOptions.rst

@@ -0,0 +1,5 @@
+=================
+Enclosure Options
+=================
+
+YARD Stick One ships without an enclosure.  It is designed to fit 3A-260906U from New Age Enclosures, but you will need to drill a hole for the SMA connector.  Another good option to protect YARD Stick One is 5/8" clear heat shrink tubing.

docs/source/faq.rst

@@ -0,0 +1,15 @@
+==========================
+Frequently Asked Questions
+==========================
+
+**Question:** What is the latest release?
+
+The latest rfcat release may be found here.
+
+**Question:** Why doesn't the LED turn on when I plug in my YARD Stick One?
+
+Yes. This is the expected behavior of RfCat firmware. The LED only illuminates while data is being transferred in transmit or receive mode.
+
+**Question:** My firmware isn't running, how do I enter bootloader mode?
+
+Bootloader mode can be triggered by connecting pins 7 and 9 on the P1 expansion header.

docs/source/firmware.rst

@@ -0,0 +1,5 @@
+========
+Firmware
+========
+
+YARD Stick One is supported by `rfcat <https://github.com/atlas0fd00m/rfcat>`__ and ships with rfcat firmware and `CC-Bootloader <https://github.com/AdamLaurie/CC-Bootloader>`__.  The firmware and hardware are open source, and you can write your own firmware if you wish.

docs/source/index.rst

@@ -0,0 +1,22 @@
+==========================================
+Welcome to YARD Stick One's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Documentation
+
+   yardstickone
+   faq
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Firmware
+
+   firmware
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Hardware
+
+   enclosureOptions

docs/source/yardstickone.rst

@@ -0,0 +1,44 @@
+==============
+YARD Stick One
+==============
+
+YARD Stick One is a sub-1 GHz wireless transceiver IC on a USB dongle. It is based on the Texas Instruments CC1111.
+
+Features
+~~~~~~~~
+
+* half-duplex transmit and receive
+* official operating frequencies: 300-348 MHz, 391-464 MHz, and 782-928 MHz
+* unofficial operating frequencies: 281-361 MHz, 378-481 MHz, and 749-962 MHz
+* modulations: ASK, OOK, GFSK, 2-FSK, 4-FSK, MSK
+* data rates up to 500 kbps
+* Full-Speed USB 2.0
+* SMA female antenna connector (50 ohms)
+* software-controlled antenna port power (max 50 mA at 3.3 V)
+* low pass filter for elimination of harmonics when operating in the 800 and 900 MHz bands
+* GoodFET-compatible expansion and programming header
+* GIMME-compatible programming test points
+* open source
+
+The official operating frequencies are those supported by Texas Instruments.  Our testing has found the unofficial range to be reliable.
+
+
+
+SMA, not RP-SMA
+~~~~~~~~~~~~~~~
+
+Some connectors that appear to be SMA are actually RP-SMA.  If you connect an RP-SMA antenna to YARD Stick One, it will seem to connect snugly but won't function at all because neither the male nor female side has a center pin.  RP-SMA connectors are most common on 2.4 GHz antennas and are popular on Wi-Fi equipment.  Adapters are available.
+
+
+
+Expansion Interface
+~~~~~~~~~~~~~~~~~~~
+
+Header P1 is available as an expansion interface.  See the schematic for the pinout.  It can also be used for firmware programming if the USB bootloader is insufficient for some reason.  You can connect a GoodFET to P1 (with a ribbon cable, for example) for programming.
+
+
+
+Project Home
+~~~~~~~~~~~~
+
+The project home page, including purchasing information can be found `here <http://greatscottgadgets.com/yardstickone/>`__.