status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc generator 

why:
  generally, there is no role for libbacktrace when docs are generated

  for vm2, undo settings of config.nim and provide the "kludge" flag, so
  circular import/include dependencies can be taken care of (not only)
  for generating docs
This commit is contained in:
Jordan Hrycaj 2021-04-12 16:36:00 +01:00 committed by zah
parent 5c01b3548d
commit fd7b1bd040
2 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
nimbus/makefile
View File

@ -39,13 +39,18 @@ endif
# Compat version is used with external NIM compiler # Compat version is used with external NIM compiler
NIM_COMPAT := --useVersion:1.2 NIM_COMPAT := --useVersion:1.2
# Name of NIM compiler, test for newer version on host OS # Name of NIMDOC compiler, test for newer version on host OS
NIM_CMD := nim NIM_CMD := nim
NIM_TEST := $(NIM_CMD) $(NIM_COMPAT) --help >/dev/null 2>&1 NIM_TEST := $(NIM_CMD) $(NIM_COMPAT) --help >/dev/null 2>&1
NIM_SELECT := $(NIM_TEST) && echo "$(NIM_CMD) $(NIM_COMPAT)"|| echo "$(NIM_CMD)" NIM_SELECT := $(NIM_TEST) && echo "$(NIM_CMD) $(NIM_COMPAT)"|| echo "$(NIM_CMD)"
# Note that the back ticks are needed in the following assignment # Note that the back ticks are needed in the following assignment
NIM_EXE := `$(NIM_SELECT)` NIM_EXE := `$(NIM_SELECT)`
# Extra nimdoc flags
NIMDOC_FLAGS := --verbosity:0 --hints:off --warnings:off
NIMDOC_FLAGS += -d:debug -d:disable_libbacktrace
NIMDOC_FLAGS += $(NIMFLAGS)
# Markdown compiler (test for discount tool with tables support) # Markdown compiler (test for discount tool with tables support)
MD_CMD := markdown MD_CMD := markdown
MD_TEST := $(MD_CMD) -VV 2>/dev/null|grep -q TABLES MD_TEST := $(MD_CMD) -VV 2>/dev/null|grep -q TABLES
@ -63,6 +68,7 @@ help::
echo echo
echo "<option>: V=1 -- verbose mode" echo "<option>: V=1 -- verbose mode"
echo " X=0 -- preferring local nim compiler (this repo)" echo " X=0 -- preferring local nim compiler (this repo)"
echo " NIMFLAGS=.. -- additional flags for nim-docs generator"
echo echo
echo "<target>: docs -- build NIM docs" echo "<target>: docs -- build NIM docs"
echo " docs-update -- process missing doc pages" echo " docs-update -- process missing doc pages"
@ -80,16 +86,17 @@ help::
# Build indexed dox # Build indexed dox
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Automatc rule for updating single html/idx file # Automatic rule for updating single html/idx file
docs/%.html : %.nim docs/%.html : %.nim
# use compat option if it works with the nim compiler # use compat option if it works with the nim compiler
@mkdir -p docs @mkdir -p docs
@nim=$(NIM_EXE); doc_root="$(DOC_ROOT)"; \ @nim=$(NIM_EXE); doc_root="$(DOC_ROOT)"; \
export NIMBLE_DIR=$(NIMBLE_DIR); \
(set -x; $$nim doc --outdir:docs --docRoot:"$$doc_root" --index:on \ (set -x; $$nim doc --outdir:docs --docRoot:"$$doc_root" --index:on \
--errorMax:0 --verbosity:0 --hints:off --warnings:off \ --errorMax:0 $(NIMDOC_FLAGS) \
"$<" $(MUFFLE)) || true "$<" $(MUFFLE)) || true
# Automatc rule for updating markdown files # Automatic rule for updating markdown files
docs/ex/%.html : %.md docs/ex/%.html : %.md
@mkdir -p $(dir $@) @mkdir -p $(dir $@)
@if $(MD_TEST); then \ @if $(MD_TEST); then \
@ -98,7 +105,7 @@ docs/ex/%.html : %.md
(echo "<pre>";(set -x;cat "$<");echo "</pre>"); \ (echo "<pre>";(set -x;cat "$<");echo "</pre>"); \
fi > "$@" fi > "$@"
# Automatc rule for collecting raw files # Automatic rule for collecting raw files
docs/ex/%.png : %.png docs/ex/%.png : %.png
@mkdir -p $(dir $@) @mkdir -p $(dir $@)
@set -x; cp "$<" "$@" @set -x; cp "$<" "$@"
@ -165,8 +172,9 @@ docs:: docs-index
.SILENT: clean-exe .SILENT: clean-exe
clean-exe: clean-exe:
for f in $(EXE_FILES); do \ for f in $(EXE_FILES); do \
[ -f "$$f" ] || continue ;\ if [ -f "$$f" ]; then (set -x; rm -f "$$f"); \
(set -x; rm -f "$$f"); \ elif [ -f "$$f.out" ]; then (set -x; rm -f "$$f.out"); \
fi ; \
done done
.SILENT: clean-docs .SILENT: clean-docs

8
nimbus/vm2/nimdoc.cfg Normal file
View File

@ -0,0 +1,8 @@
# breaks circular import/include dependencies
-d:kludge:2
# undo settings from config.nim
-u:nimStackTraceOverride
-u:metrics
--excessiveStackTrace:off
--threads:off