diff options
| author | Glenn Smith <glenn@vector35.com> | 2020-12-08 05:42:13 -0500 |
|---|---|---|
| committer | Glenn Smith <glenn@vector35.com> | 2020-12-08 05:42:13 -0500 |
| commit | ebfcd344e33c010860abbdb240292c96e25efb65 (patch) | |
| tree | 427c5ebe9f0b929ef23ae493705e46520a96ffbc | |
| parent | 2a608956279a2bc37c762f3f2b5e20ee38b1f43c (diff) | |
Support generating dash docsets
| -rw-r--r-- | api-docs/Makefile | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/api-docs/Makefile b/api-docs/Makefile index 5da106b3..20b8a369 100644 --- a/api-docs/Makefile +++ b/api-docs/Makefile @@ -4,6 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS ?= -j auto SPHINXBUILD ?= sphinx-build +DOC2DASH ?= doc2dash PAPER = BUILDDIR ?= build SOURCEDIR ?= source @@ -40,6 +41,7 @@ help: @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " dashdoc to make a Dash docset" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " coverage to run coverage check of the documentation (if enabled)" @@ -222,6 +224,15 @@ pseudoxml: @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +.PHONY: dashdoc +dashdoc: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/dashhtml + # Probably a cleaner way to do this + @echo ".wy-nav-side {display: none;}.wy-nav-content-wrap {margin-left: 0;}" >> $(BUILDDIR)/dashhtml/_static/css/theme.css + $(DOC2DASH) -n 'Binary Ninja' -d $(BUILDDIR)/docset $(BUILDDIR)/dashhtml + @echo + @echo "Build finished; now you can open the docset in $(BUILDDIR)/docset." + .PHONY: dummy dummy: $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy |