Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ jobs:
python -c "import dapper; print('dapper imported from:', dapper.__file__)"

- name: Build Sphinx
run: sphinx-build -b html docs docs/_build/html
run: |
sphinx-build -b html docs docs/_build/html

# For pushes (main): hand off to Pages
- name: Upload artifact for Pages
Expand Down
14 changes: 14 additions & 0 deletions docs/_static/dapper_custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,17 @@ table.docutils td, table.docutils th {
vertical-align: top;
padding: 0.35rem 0.5rem;
}

.sidebar-drawer {
max-width: 8%;
}

.toc-drawer {
margin-left: auto;
max-width: 12%;
}

.content {
min-width: 82%;
}

12 changes: 6 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
from __future__ import annotations

"""Sphinx configuration for dapper documentation."""

import os
from pathlib import Path
import sys

"""Sphinx configuration for dapper documentation."""

# Ensure Sphinx can find src/ before installation
import os
import sys
sys.path.insert(0, os.path.abspath("../src"))


Expand All @@ -21,6 +19,7 @@

try:
import dapper # noqa: F401

release = getattr(dapper, "__version__", "")
except Exception:
release = ""
Expand Down Expand Up @@ -78,7 +77,7 @@
"dapper_custom.css",
]

python_use_unqualified_type_names = False # for handling mutiple imports of same name
python_use_unqualified_type_names = False # for handling mutiple imports of same name


def _generate_surface_var_docs() -> None:
Expand All @@ -87,6 +86,7 @@ def _generate_surface_var_docs() -> None:
if script.exists():
# run via same interpreter to ensure imports resolve
import subprocess

subprocess.check_call([sys.executable, str(script)])


Expand Down