Use kedro-sphinx-theme
#3675
Use kedro-sphinx-theme
#3675
Conversation
|
This is now fulfilling the vision I outlined in #3586 and is using the newly created https://github.com/kedro-org/kedro-sphinx-theme to style the documenation. Notice that this PR removes our custom It's clear that
https://kedro--3675.org.readthedocs.build/en/3675/ @tynandebold @jitu5 @rashidakanchwala shall we have a look at this sometime soon? |
astrojuanlu
force-pushed
the
docs/use-kedro-sphinx-theme
branch
from
31b8207
to
c7883c9
Compare
|
I fixed the CSS, now I think it's equal pixel by pixel 👍🏽 Please review |
|
(This wasn't planned, so no rush) |
| def env_override(default_appid): | ||
| build_version = os.getenv("READTHEDOCS_VERSION") | ||
|
|
||
| if build_version == "latest": | ||
| return os.environ["HEAP_APPID_QA"] | ||
| if build_version == "stable": | ||
| return os.environ["HEAP_APPID_PROD"] | ||
|
|
||
| return default_appid # default to Development for local builds | ||
|
|
||
|
|
||
| def _add_jinja_filters(app): |
There was a problem hiding this comment.
Thinking that maybe these functions should stay here, instead of being in the theme itself
| str(css_path / "qb1-sphinx-rtd.css"), | ||
| str(css_path / "theme-overrides.css"), | ||
| ) | ||
| return (str(css_path / "copybutton.css"),) |
There was a problem hiding this comment.
Just found out that this function exists after doing this PR, and I noticed that it's used in all the starters...
| "sphinx-autodoc-typehints==1.20.2", | ||
| "sphinx_copybutton==0.5.2", | ||
| "sphinx-notfound-page", | ||
| "kedro-sphinx-theme @ git+https://github.com/kedro-org/kedro-sphinx-theme@main", |
There was a problem hiding this comment.
If this approach is well received obviously this should be pinned to a tag, or even a proper release on PyPI
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
force-pushed
the
docs/use-kedro-sphinx-theme
branch
from
1eda07a
to
6d27fdc
Compare
Description
#3586
Development notes
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-byline in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.mdfile