Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Draft] - to test changes from kedro-sphinx-theme #1955

Closed
wants to merge 24 commits into from
5 changes: 5 additions & 0 deletions demo-project/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,8 @@ known_third_party = "kedro"
addopts = """
--cov-report term-missing \
--cov src/demo_project -ra"""

docs = [
"kedro-sphinx-theme",
"sphinx-favicon",
]
8 changes: 6 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,12 @@
"myst_parser",
"notfound.extension",
"sphinxcontrib.jquery",
'sphinx_favicon',
]

favicons = [
"https://kedro.org/images/favicon.ico",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -57,6 +61,7 @@
"kedro-datasets": ("https://docs.kedro.org/projects/kedro-datasets/en/kedro-datasets-3.0.0/", None),
}


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -78,12 +83,11 @@
"github_url": "https://github.com/kedro-org/kedro/tree/main/docs/source",
}


def _override_permalinks_icon(app):
# https://github.com/readthedocs/sphinx_rtd_theme/issues/98#issuecomment-1503211439
app.config.html_permalinks_icon = "¶"


def setup(app):
app.connect("builder-inited", _override_permalinks_icon)


3 changes: 2 additions & 1 deletion package/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@
},
extras_require={
"docs": [
"kedro-sphinx-theme==2024.4.0",
"kedro-sphinx-theme @ git+https://github.com/kedro-org/kedro-sphinx-theme.git@fix-favicon",
],
"aws": ["s3fs>=2021.4"],
"azure": ["adlfs>=2021.4"],
"gcp": ["gcsfs>=2021.4"],
},
)

Loading