diff options
| author | Martin Braun <martin.braun@ettus.com> | 2022-01-21 15:36:22 +0100 |
|---|---|---|
| committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2022-02-01 14:48:56 -0600 |
| commit | f6733edc53f9c85c3b3ce67ee766181aa96b99ca (patch) | |
| tree | ac56f94f70b71d0d7ef2242f80b37448531b3284 /host/docs/sphinx/Makefile | |
| parent | 930fa39c601d1601884ca6ead9f44841f0348f18 (diff) | |
| download | uhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.tar.gz uhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.tar.bz2 uhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.zip | |
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.
Diffstat (limited to 'host/docs/sphinx/Makefile')
| -rw-r--r-- | host/docs/sphinx/Makefile | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/host/docs/sphinx/Makefile b/host/docs/sphinx/Makefile new file mode 100644 index 000000000..69fe55ecf --- /dev/null +++ b/host/docs/sphinx/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)
\ No newline at end of file |