Skip to content

Commit fee62e1

Browse files
authored
Merge pull request #59 from aboutcode-org/documentaion
Add documentation for getting started and remote subscription
2 parents 7edac59 + 8e5b0f5 commit fee62e1

13 files changed

+185
-1
lines changed

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,10 @@ run:
116116
@echo "-> Starting development server"
117117
${MANAGE} runserver 8000 --insecure
118118

119-
.PHONY: dev envfile isort black doc8 valid bandit check check-deploy clean migrate test docs postgresdb backupdb run
119+
check_docs:
120+
@echo "Check Sphinx Documentation build minimally"
121+
@${ACTIVATE} sphinx-build -E -W docs/source build
122+
@echo "Check for documentation style errors"
123+
@${ACTIVATE} doc8 --max-line-length 100 docs/source --ignore-path docs/_build/ --ignore D000 --quiet
124+
125+
.PHONY: dev envfile isort black doc8 valid bandit check check-deploy clean migrate test docs postgresdb backupdb run check_docs
32.5 KB
Loading
70.2 KB
Loading
119 KB
Loading
114 KB
Loading
109 KB
Loading
98.1 KB
Loading
125 KB
Loading
194 KB
Loading
364 KB
Loading

0 commit comments

Comments
 (0)