Skip to content

Commit

Permalink
Uniformize HACF docs & move theme to Furo
Browse files Browse the repository at this point in the history
  • Loading branch information
Quentame authored Oct 23, 2023
1 parent b1a8f1c commit b68b346
Show file tree
Hide file tree
Showing 5 changed files with 169 additions and 105 deletions.
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
version: 2
sphinx:
configuration: docs/conf.py
formats: all
python:
install:
Expand All @@ -10,3 +8,5 @@ build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: docs/conf.py
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx==7.2.6
sphinx-rtd-theme==1.3.0
furo==2023.9.10
8 changes: 4 additions & 4 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
try:
from nox_poetry import Session
from nox_poetry import session
except ImportError:
except ImportError as err:
message = f"""\
Nox failed to import the 'nox-poetry' package.
Please install it using the following command:
{sys.executable} -m pip install nox-poetry"""
raise SystemExit(dedent(message)) from None
raise SystemExit(dedent(message)) from err


package = "freebox_api"
Expand Down Expand Up @@ -172,7 +172,7 @@ def docs_build(session: Session) -> None:
"""Build the documentation."""
args = session.posargs or ["docs", "docs/_build"]
session.install(".")
session.install("sphinx", "sphinx-click", "sphinx-rtd-theme")
session.install("sphinx", "sphinx-click", "furo")

build_dir = Path("docs", "_build")
if build_dir.exists():
Expand All @@ -186,7 +186,7 @@ def docs(session: Session) -> None:
"""Build and serve the documentation with live reloading on file changes."""
args = session.posargs or ["--open-browser", "docs", "docs/_build"]
session.install(".")
session.install("sphinx", "sphinx-autobuild", "sphinx-click", "sphinx-rtd-theme")
session.install("sphinx", "sphinx-autobuild", "sphinx-click", "furo")

build_dir = Path("docs", "_build")
if build_dir.exists():
Expand Down
Loading

0 comments on commit b68b346

Please sign in to comment.