Skip to content

Commit

Permalink
Fix make file so it properly builds the developer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
krzywon committed Dec 6, 2023
1 parent a9e77e5 commit fc79b94
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Minimal makefile for Sphinx documentation
#

# Environment variables
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SPHINXAPIDOC ?= sphinx-apidoc
APIOPTS = -d 8 -H SasData
DOCSDIR = docs
SOURCEDIR = source
BUILDDIR = build
CD = cd
DEVDIR = dev
LIBDIR = lib
GENDIR = generated
UP = ..

ifdef ComSpec
RMDIR = rmdir /s/q
Expand All @@ -20,27 +23,31 @@ else
PATHSEP = $(strip /)
endif

LIBDIR = $(BUILDDIR)$(PATHSEP)lib
SASDATABUILD = $(UP)$(PATHSEP)$(BUILDDIR)$(PATHSEP)$(LIBDIR)
DOCSSRC = $(SOURCEDIR)
DEV = $(DOCSSRC)$(PATHSEP)$(DEVDIR)
DEVGEN = $(DEV)$(PATHSEP)$(GENDIR)
DOCSBUILD = $(DOCSSRC)$(PATHSEP)$(BUILDDIR)

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
-$(RMDIR) "$(SOURCEDIR)$(PATHSEP)dev$(PATHSEP)generated/" "$(BUILDDIR)"
-$(RMDIR) "$(DEVGEN)" "$(DOCSBUILD)"

dir:
-$(MKDIR) "$(BUILDDIR)"
-$(MKDIR) "$(LIBDIR)"
-$(MKDIR) "$(DEVGEN)"
-$(MKDIR) "$(DOCSBUILD)"

.PHONY: help Makefile

# Generate the api docs
api:
$(SPHINXAPIDOC) -o "$(SOURCEDIR)$(PATHSEP)dev$(PATHSEP)generated/" $(APIOPTS) "$(LIBDIR)"
$(SPHINXAPIDOC) -o "$(DEVGEN)" $(APIOPTS) "$(SASDATABUILD)"

html: dir api
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(DOCSSRC)" "$(DOCSBUILD)" $(SPHINXOPTS) $(O)

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down

0 comments on commit fc79b94

Please sign in to comment.