Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes for sphinx build #1063

Merged
merged 32 commits into from
Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
13cf436
Switch to sphinx-build
ericwb Sep 22, 2023
dae47ea
Update requirements.txt
ericwb Sep 22, 2023
3f66a96
Merge branch 'main' into ericwb-patch-2
ericwb Dec 8, 2023
bf41ba9
Update requirements.txt
ericwb Dec 8, 2023
ec73c9c
Update conf.py
ericwb Dec 8, 2023
7cd9e7b
Update conf.py
ericwb Dec 8, 2023
b78df9a
Update conf.py
ericwb Dec 8, 2023
0ef53b7
Update conf.py
ericwb Dec 8, 2023
3d35aca
Update __init__.py
ericwb Dec 8, 2023
265c8ee
Update __init__.py
ericwb Dec 8, 2023
aaafd41
Update __init__.py
ericwb Dec 8, 2023
49a377a
Update __init__.py
ericwb Dec 8, 2023
b3fcf0d
Update __init__.py
ericwb Dec 8, 2023
0dec5d9
Update conf.py
ericwb Dec 8, 2023
12f2b82
Update conf.py
ericwb Dec 8, 2023
e48691e
Update conf.py
ericwb Dec 8, 2023
31a67a9
Update __init__.py
ericwb Dec 8, 2023
8ef9b92
Update __init__.py
ericwb Dec 8, 2023
a0ab714
Update __init__.py
ericwb Dec 8, 2023
6fa3f20
Update __init__.py
ericwb Dec 8, 2023
c6f84d5
Merge branch 'main' into ericwb-patch-2
ericwb Dec 8, 2023
41db60b
Update __init__.py
ericwb Dec 8, 2023
bb04821
Update __init__.py
ericwb Dec 8, 2023
46fe0cd
Update .readthedocs.yaml
ericwb Dec 8, 2023
e947ad3
Update .readthedocs.yaml
ericwb Dec 8, 2023
dc975ea
Update __init__.py
ericwb Dec 8, 2023
a832359
Update __init__.py
ericwb Dec 8, 2023
5cb5ec9
Update __init__.py
ericwb Dec 8, 2023
00eccb5
Update __init__.py
ericwb Dec 8, 2023
a3ca00c
Update .readthedocs.yaml
ericwb Dec 8, 2023
a47bbaa
Update __init__.py
ericwb Dec 9, 2023
7760571
Update .readthedocs.yaml
ericwb Dec 9, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion bandit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,8 @@
from bandit.core.issue import * # noqa
from bandit.core.test_properties import * # noqa

__version__ = metadata.version("bandit")
try:
__version__ = metadata.version("bandit")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please no

except metadata.PackageNotFoundError:
# FIXME: Sphinx has trouble fetching the version during its build.
__version__ = "0.0.0"
6 changes: 3 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../.."))
sys.path.insert(0, os.path.abspath(os.path.join("..", "..")))
# -- General configuration ----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
Expand All @@ -23,11 +23,11 @@
source_suffix = ".rst"

# The root toctree document.
master_doc = "index"
root_doc = "index"

# General information about the project.
project = "Bandit"
copyright = "2022, Bandit Developers"
copyright = "2023, Bandit Developers"

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ commands =
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands=
python setup.py build_sphinx
sphinx-build doc/source doc/build

[flake8]
# [H106] Don't put vim configuration in source files.
Expand Down