Skip to content

docs: Add manpages #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kienanstewart wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Add manpages #346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,7 @@ examples

# IntelliJ
.idea/

# Rendered manpages
docs/man/*.1
docs/man/*.5
21 changes: 20 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ OTHER_FILES=count.py
MODULES=vermin tests
TOP_LEVEL_FILES=${MODULES} vermin.py runtests.py ${OTHER_FILES}
SEMGREP_CMD=semgrep ci --metrics off --timeout 60 --verbose
MANPAGES=docs/man/vermin.1 docs/man/vermin.ini.5
RSTMAN ?= rst2man

test-self:
./vermin.py --violations -q -t=3 ${VERMIN_FILES}
Expand All @@ -29,7 +31,10 @@ setup-coverage: clean
setup-analysis: clean
pip install -r misc/.analysis-requirements.txt

setup: setup-venv setup-analysis
setup-docs: clean
pip install -r misc/.docs-requirements.txt

setup: setup-venv setup-analysis setup-docs

install-deps:
python -m pip install --upgrade pip virtualenv
Expand Down Expand Up @@ -95,3 +100,17 @@ test-coverage:

coverage-report:
coverage report -m

define docs_rule
$(1): $(1).rst
$(RSTMAN) $(1).rst $(1)
endef

$(foreach manpage,$(MANPAGES),$(eval $(call docs_rule,$(manpage))))

docs: $(MANPAGES)

clean-docs:
rm -f $(MANPAGES)

.PHONY: docs clean-docs
Loading
Loading