Skip to content

Commit

Permalink
docs: add "make docs" target to wrap Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
cfm committed Apr 28, 2022
1 parent 2f110d5 commit aa18985
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Doxygen output from "make docs"
docs/

*.sqlite

# Byte-compiled / optimized / DLL files
Expand Down
4 changes: 2 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY =
OUTPUT_DIRECTORY = docs

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down Expand Up @@ -1817,7 +1817,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.

GENERATE_LATEX = YES
GENERATE_LATEX = NO

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,14 @@ help: ## Print this message and exit.
version:
@python -c "import securedrop_client; print(securedrop_client.__version__)"


.PHONY: docs
docs: ## Generate browsable documentation and call/caller graphs (requires Doxygen and Graphviz)
@which doxygen >> /dev/null || { echo "doxygen(1) is not available in your \$$PATH. Is it installed?"; exit 1; }
@which dot >> /dev/null || { echo "Graphviz's dot(1) is not available in your \$$PATH. Is it installed?"; exit 1; }
@doxygen
@echo "Now open \"$(PWD)/docs/html/index.html\" in your browser."

##############
#
# Localization
Expand Down

0 comments on commit aa18985

Please sign in to comment.