Add Sphinx hyperlink replacement

Author: thisac

docs/Makefile

@@ -22,20 +22,30 @@ ADD_DOWNLOAD_BUTTONS ="$\
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-# 0. create the output folder and copy all Python source files over to it
-# 1. find all Python demos and convert them to Jupyter notebooks
-# 2. find all Jupyter notebooks and convert them into Sphinx rst files
-# 3. find all rst files and add the file name as a label at the top
-# 4. find all rst files and add the download links to the bottom
 .PHONY: demos
 demos:
+	# 0. create the output folder and copy all Python source files over to it
 	mkdir -p $(OUTFOLDER)
 	cp -a $(DEMOFOLDER)/. $(OUTFOLDER)
 
+	# 1. find all Python demos and convert them to Jupyter notebooks
 	find $(DEMOFOLDER) -name '*.py' -exec sh -c '$(JUPYTEXT) --to ipynb $$1 --output "$(OUTFOLDER)/$$(basename $$1 .py).ipynb"' sh {} \;
+
+	# 2. find all Jupyter notebooks and convert them into Sphinx rst files
 	find $(OUTFOLDER) -name '*.ipynb' -exec $(NBCONVERT) {} --to rst --output-dir=$(OUTFOLDER) --execute --RegexRemovePreprocessor.patterns="^%" \;
+
+	# 3. find all rst files and add the file name as a label at the top
 	find $(OUTFOLDER) -name '*.rst' -exec sh -c 'sed -i "1s/^/.. _$$(basename $$1 .rst):\n\n/" $$1' sh {} \;
 
+	# 4. find all rst files and replace major classes/methods with Sphinx hyperlinks
+	find $(OUTFOLDER) -name '*.rst' -exec sh -c 'sed --in-place \
+		-e "s/\`\`Circuit\`\`/:class:\`~dwave.gate.circuit.Circuit\`/g" \
+		-e "s/\`\`Circuit\.\(\w*\)\`\`/:meth:\`~dwave.gate.circuit.Circuit.\1\`/g" \
+		-e "s/\`\`operations\`\`/:mod:\`~dwave.gate.operations\`/g" \
+		-e "s/\`\`ops\.\(\w*\)\`\`/:class:\`~dwave.gate.operations.operations.\1\`/g" \
+	$$1' sh {} \; \
+
+	# 5. find all rst files and add the download links to the bottom
 	find $(OUTFOLDER) -name '*.rst' -exec sh -c 'sed -i -e $(ADD_DOWNLOAD_BUTTONS) $$1' sh {} \;
 
 .PHONY: help Makefile