From f3a18ab30bc444e62d02505419ab7059cead0853 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Fri, 8 Dec 2023 17:18:38 -0800 Subject: [PATCH] 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 --- .readthedocs.yaml | 2 ++ doc/source/conf.py | 6 +++--- tox.ini | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 140aba1e..4afff4ab 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,3 +12,5 @@ python: install: - requirements: requirements.txt - requirements: doc/requirements.txt + - method: pip + path: . diff --git a/doc/source/conf.py b/doc/source/conf.py index aec14010..869c1b3a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 @@ -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 diff --git a/tox.ini b/tox.ini index 7a2208b5..f8fddff9 100644 --- a/tox.ini +++ b/tox.ini @@ -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.