Skip to content

Commit

Permalink
docs: added make target 'autogenerated-json' to Makefile
Browse files Browse the repository at this point in the history
- this command exports the configs into json files from the bareos-binaries
  and then rebuilds the config rst files
- whereas 'autogenerate' just autogenerates the config rst files from the
  already present json files; this helps if someone just wants to build
  the documentation but does not have the binaries to export the config
  • Loading branch information
franku committed May 15, 2019
1 parent 8fa237d commit f3cc416
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/manuals/en/new_main_reference/Makefile
Expand Up @@ -45,42 +45,42 @@ include/autogenerated/bareos-tray-monitor-*.rst.inc: autogenerated/bareos-tray-m
$(GENERATE_RESOURCE_DESCRIPTIONS) autogenerated/bareos-tray-monitor-config-schema.json

autogenerated/bareos-dir-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirect output to a json file.
$(BAREOS_DIR) -xs >/dev/null && \
$(BAREOS_DIR) -xs > autogenerated/bareos-dir-config-schema.json;

autogenerated/bareos-sd-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirect output to a json file.
$(BAREOS_SD) -xs >/dev/null && \
$(BAREOS_SD) -xs > autogenerated/bareos-sd-config-schema.json;

autogenerated/bareos-fd-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirect output to a json file.
$(BAREOS_FD) -xs >/dev/null && \
$(BAREOS_FD) -xs > autogenerated/bareos-fd-config-schema.json;

autogenerated/bconsole-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirect output to a json file.
$(BCONSOLE) -xs >/dev/null && \
$(BCONSOLE) -xs > autogenerated/bconsole-config-schema.json;

autogenerated/bareos-tray-monitor-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirect output to a json file.
$(BAREOS_TRAY_MONITOR) -xs >/dev/null && \
$(BAREOS_TRAY_MONITOR) -xs > autogenerated/bareos-tray-monitor-config-schema.json;

autogenerated: $(GENERATED)

autogenerated-json:
rm -rf autogenerated/*.json
make autogenerated
@git diff --quiet source/include/autogenerated/ || echo "!!! *** Attention, config directive has changed *** !!!"

sphinx:
#sphinx-versioning -l source/conf.py build docs/manuals/en/new_main_reference/source/ docs/manuals/en/new_main_reference/BareosMainReference/
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Expand All @@ -89,5 +89,5 @@ sphinx:
clean:
rm -rf build/*
rm -rf BareosMainReference/*
rm -rf autogenerated/*
rm -rf autogenerated/*.rst.inc

0 comments on commit f3cc416

Please sign in to comment.