Ensure the man page is built

Ever since Sphinx switched to sphinx-build command to build
docs, the man page was no longer being built. This is because
there is now a separate subcommand "sphinx-build -b man" to
generate the man page file.

This change adds the separate command and ensures our publish
workflows generate the file when releasing a new bandit version.

This also adds the man page as part of the data files so it
gets included with the wheel and is installed to share/man/man1.

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>

Author: ericwb

.github/workflows/publish-to-pypi.yml

@@ -21,6 +21,12 @@ jobs:
     - name: Install dependencies
       run: pip install wheel
 
+    - name: Build man page if not present
+      run: |
+        if [ ! -f doc/build/man/bandit.1 ]; then
+          tox run -e docs
+        fi
+
     - name: Build a binary wheel and a source tarball
       run: |
         python setup.py sdist bdist_wheel

.github/workflows/publish-to-test-pypi.yml

@@ -21,6 +21,12 @@ jobs:
     - name: Install dependencies
       run: pip install wheel
 
+    - name: Build man page if not present
+      run: |
+        if [ ! -f doc/build/man/bandit.1 ]; then
+          tox run -e docs
+        fi
+
     - name: Build a binary wheel and a source tarball
       run: |
         python setup.py sdist bdist_wheel

setup.cfg

@@ -169,6 +169,9 @@ all_files = 1
 build-dir = doc/build
 source-dir = doc/source
 
+[options.data_files]
+share/man/man1 = doc/build/man/bandit.1
+
 [pbr]
 autodoc_tree_index_modules = True
 autodoc_tree_excludes =

tox.ini

@@ -67,6 +67,7 @@ commands =
 deps = -r{toxinidir}/doc/requirements.txt
 commands=
     sphinx-build doc/source doc/build
+    sphinx-build -b man doc/source doc/build/man
 
 [flake8]
 # [H106] Don't put vim configuration in source files.