Skip to content

Commit

Permalink
Fixes for sphinx build (#1063)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
ericwb authored Dec 9, 2023
1 parent 4dea02e commit f3a18ab
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ python:
install:
- requirements: requirements.txt
- requirements: doc/requirements.txt
- method: pip
path: .
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

0 comments on commit f3a18ab

Please sign in to comment.