update description and 'force arg

RJbalikian · May 2, 2023 · c592da6 · c592da6
1 parent 9d336aa
commit c592da6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/generate_docs_pdoc.py b/docs/generate_docs_pdoc.py
@@ -1,3 +1,4 @@
+#This script generates simple documentation using the pdoc3 library that can easily be published on github pages
 import os
 import subprocess
 
@@ -8,6 +9,6 @@
 os.environ['PYTHONPATH'] = '..' + os.pathsep + os.environ.get('PYTHONPATH', '')
 
 # Run the pdoc command
-subprocess.run(['pdoc3', '--html', mod, '-o', output_dir, --force])
+subprocess.run(['pdoc3', '--html', mod, '-o', output_dir, '--force'])
 os.chdir('./docs')
 os.rename(mod[:-3]+'.html', 'index.html')