Skip to content

Commit

Permalink
docs: Switch to ODSC theme & config
Browse files Browse the repository at this point in the history
  • Loading branch information
odscjames committed Sep 27, 2024
1 parent b324850 commit 3cce0a6
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
extra_requirements:
- dev
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
project = "JSON Data Ferret"

master_doc = "index"

html_theme = "odsc_default_sphinx_theme"
10 changes: 9 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,15 @@
"json-merge-patch",
],
extras_require={
"dev": ["pip-tools", "black==22.3", "flake8", "isort", "django-environ"]
"dev": [
"pip-tools",
"black==22.3",
"flake8",
"isort",
"django-environ",
"sphinx",
"odsc-default-sphinx-theme",
]
},
python_requires=">=3.9",
)

0 comments on commit 3cce0a6

Please sign in to comment.