mirror of
https://github.com/bellingcat/cisticola.git
synced 2026-06-11 21:08:34 +03:00
added and made more consistent docstrings, wrote script that makes minor edits to Sphinx apidocs to improve documentation clarity
This commit is contained in:
@@ -14,6 +14,8 @@ MODULEPATH = ../cisticola
|
||||
SOURCEFILES = cisticola.*
|
||||
MODULEFILE = modules.rst
|
||||
|
||||
POST_APIDOC = edit_apidoc.sh
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@@ -25,6 +27,8 @@ apidoc:
|
||||
rm $(SOURCEDIR)/$(SOURCEFILES)
|
||||
$(SPHINXAPIDOC) $(APIDOCFLAGS) -o "$(SOURCEDIR)" "$(MODULEPATH)"
|
||||
rm $(SOURCEDIR)/$(MODULEFILE)
|
||||
bash $(POST_APIDOC)
|
||||
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
|
||||
Reference in New Issue
Block a user