Skip to content

Commit

Permalink
[DOCUMENTATION] debugged sphinx build features some more (- WIP #110 -)
Browse files Browse the repository at this point in the history
### ChangeLog:

Changes in file Makefile:
 cleanup:
 else
 endif

Changes in file docs/conf.py:
 Unknown Changes
  • Loading branch information
reactive-firewall committed Sep 16, 2024
1 parent dc6693f commit 66b6457
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
24 changes: 13 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,6 @@ ifeq "$(LINK)" ""
LINK=ln -sf
endif

ifeq "$(GIT)" ""
GIT=$(COMMAND) git
endif

ifeq "$(GIT_WORK_TREE)" ""
GIT_WORK_TREE=$(shell -c "$(GIT) rev-parse --show-toplevel")
endif

ifeq "$(PYTHON)" ""
PY_CMD=$(COMMAND) python3
ifneq "$(PY_CMD)" ""
Expand Down Expand Up @@ -149,13 +141,12 @@ endif

.PHONY: cleanup init clean-docs must_be_root must_have_flake must_have_pytest uninstall

build: init ./setup.py build-docs
build: init ./setup.py
$(QUIET)$(PYTHON) -W ignore -m build --sdist --wheel --no-isolation ./ || $(QUIET)$(PYTHON) -W ignore -m build ./ ;
$(QUITE)$(WAIT)
$(QUIET)$(ECHO) "build DONE."

init:
$(QUIET)$(ECHO) "Building from ... $(GIT_WORK_TREE)"
$(QUIET)$(PYTHON) -m pip install $(PIP_COMMON_FLAGS) $(PIP_ENV_FLAGS) "pip>=19.0" "setuptools>=38.0" "wheel>=0.37" "build>=1.0.1" 2>$(ERROR_LOG_PATH) || :
$(QUIET)$(PYTHON) -m pip install $(PIP_COMMON_FLAGS) $(PIP_ENV_FLAGS) -r requirements.txt 2>$(ERROR_LOG_PATH) || :
$(QUIET)$(ECHO) "$@: Done."
Expand Down Expand Up @@ -266,10 +257,21 @@ cleanup:
build-docs: ./docs/ ./docs/Makefile ./docs/requirements.txt
$(QUIET)$(PYTHON) -m pip install $(PIP_COMMON_FLAGS) $(PIP_ENV_FLAGS) -r ./docs/requirements.txt 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(WAIT) ;
$(QUIET)$(MAKE) -s -C ./docs/ -f Makefile html 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(MAKE) -s -C ./docs/ -f Makefile html 2>$(ERROR_LOG_PATH) || DO_FAIL="exit 2" ;
$(QUIET)$(WAIT) ;
$(QUIET)mkdir $(INST_OPTS) ./docs/www 2>$(ERROR_LOG_PATH) >$(ERROR_LOG_PATH) || : ;
$(QUIET)$(BSMARK) ./docs/www 2>$(ERROR_LOG_PATH) >$(ERROR_LOG_PATH) || : ;
$(QUIET)$(WAIT) ;
$(QUIET)cp -fRp ./docs/_build/ ./docs/www/ 2>$(ERROR_LOG_PATH) || DO_FAIL="exit 35" ;
$(QUIET)$(WAIT) ;
$(QUIET)$(MAKE) -s -C ./docs/ -f Makefile clean 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(WAIT) ;
$(QUIET)$(ECHO) "Documentation should be in docs/www/html/"
$(QUIET)$(DO_FAIL) ;

clean-docs: ./docs/ ./docs/Makefile
$(QUIET)$(RM) ./docs/www/* 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(RMDIR) ./docs/www/ 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(MAKE) -s -C ./docs/ -f Makefile clean 2>$(ERROR_LOG_PATH) || : ;
$(QUIET)$(WAIT) ;

Expand Down
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

import sys
import os
import argparse

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down

0 comments on commit 66b6457

Please sign in to comment.