Skip to content

Commit

Permalink
add sphinx theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Graeme22 committed Jan 14, 2025
1 parent cb7be2d commit 406b057
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 9 deletions.
12 changes: 6 additions & 6 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ build:
os: "ubuntu-22.04"
tools:
python: "3.10"
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv sync --dev
- uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv sync --dev
- uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
sphinx:
configuration: docs/conf.py

Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: install lint test
.PHONY: install lint test docs

install:
uv sync
Expand All @@ -11,3 +11,6 @@ lint:

test:
uv run pytest --cov=tradestation --cov-report=term-missing tests/ --cov-fail-under=95

docs:
uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs/ docs/_build/
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []
extensions = ["sphinx_rtd_theme"]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
Expand All @@ -23,5 +23,5 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ dev-dependencies = [
"pyright>=1.1.391",
"pytest-aio>=1.9.0",
"sphinx>=8.1.3",
"sphinx-rtd-theme>=3.0.2",
]

[tool.setuptools.package-data]
Expand Down
28 changes: 28 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 406b057

Please sign in to comment.