Skip to content

Commit f3a18ab

Browse files
authored
Fixes for sphinx build (#1063)
* Switch to sphinx-build The build_sphinx command has long since replaced with sphinx-build. * Update requirements.txt * Update requirements.txt * Update conf.py * Update conf.py * Update conf.py * Update conf.py * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update conf.py * Update conf.py * Update conf.py * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update .readthedocs.yaml * Update .readthedocs.yaml * Update __init__.py * Update __init__.py * Update __init__.py * Update __init__.py * Update .readthedocs.yaml * Update __init__.py * Update .readthedocs.yaml
1 parent 4dea02e commit f3a18ab

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

.readthedocs.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ python:
1212
install:
1313
- requirements: requirements.txt
1414
- requirements: doc/requirements.txt
15+
- method: pip
16+
path: .

doc/source/conf.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import os
33
import sys
44

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

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

2525
# The root toctree document.
26-
master_doc = "index"
26+
root_doc = "index"
2727

2828
# General information about the project.
2929
project = "Bandit"
30-
copyright = "2022, Bandit Developers"
30+
copyright = "2023, Bandit Developers"
3131

3232
# If true, '()' will be appended to :func: etc. cross-reference text.
3333
add_function_parentheses = True

tox.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ commands =
6565
[testenv:docs]
6666
deps = -r{toxinidir}/doc/requirements.txt
6767
commands=
68-
python setup.py build_sphinx
68+
sphinx-build doc/source doc/build
6969

7070
[flake8]
7171
# [H106] Don't put vim configuration in source files.

0 commit comments

Comments
 (0)