Skip to content

Commit

Permalink
docs: codestyle conf.py, add requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
wagner-intevation committed Oct 12, 2023
1 parent 66191be commit 14271ef
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ check_all:

docs:
make -C docs html

pycodestyle:
pycodestyle docs/ example_scripts/ extras/ intelmqmail/ sql/ templates/ tests/
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,16 +266,19 @@

# -- Custom options -------------------------------------------------------


def run_apidoc(_):
subprocess.check_call("sphinx-apidoc --implicit-namespaces -o source ../intelmqmail", shell=True)


# Always document the __init__ methods
# https://stackoverflow.com/a/5599712/2851664
def skip(app, what, name, obj, would_skip, options):
if name == "__init__":
return False
return would_skip


def setup(app):
app.connect("autodoc-skip-member", skip)
app.connect("builder-inited", run_apidoc)
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx
sphinxcontrib-apidoc

0 comments on commit 14271ef

Please sign in to comment.