Skip to content

Commit

Permalink
docs: add the las_updated information on all pages (#395)
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau authored Dec 4, 2024
2 parents a7e1a58 + c898d4f commit 1a0b37b
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 4 deletions.
35 changes: 31 additions & 4 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -1,21 +1,48 @@
/* add dollar sign in console code-block */
/*******************************************************************************
* add dollar sign in console code-block
*/
div.highlight-console pre span.go::before {
content: "$";
margin-right: 10px;
margin-left: 5px;
}

/* Create a custom api admonition */
/*******************************************************************************
* Create a custom api admonition
*/
div.admonition.admonition-api > .admonition-title::after {
content: "\f121"; /* the fa-code icon */
}

/* increase width of the main content */
/*******************************************************************************
* custom sizing
*/
.bd-main .bd-content .bd-article-container {
max-width: 100%; /* default is 60em */
}

/* increase width of the page */
.bd-page-width {
max-width: 110rem; /* default is 88rem */
}

/*******************************************************************************
* custom article footer rendering
*/
footer.bd-footer-article {
background-color: transparent;
border-top: 1px solid var(--pst-color-border);
margin-top: 2em;
}

.bd-footer-article .footer-article-items {
flex-direction: row;
}

.bd-footer-article .footer-article-items .footer-article-item {
flex-grow: 1;
}

.bd-footer-article .last-updated {
color: var(--pst-color-text-muted);
text-align: right;
}
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"sphinx.ext.autosectionlabel",
"sphinxcontrib.icon",
"sphinx_design",
"sphinx_last_updated_by_git",
"sphinx_copybutton",
"autoapi.extension",
"jupyter_sphinx",
Expand Down Expand Up @@ -88,6 +89,7 @@
"page-toc.html",
"edit-this-page.html",
],
"article_footer_items": ["last-updated"],
# remove the switcher for now as the version management is not satisfying
# "switcher": {
# "json_url": json_url,
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ doc = [
"myst-nb",
"pytest-gee>=0.3.7", # avoid issue with rdt env variables
"sphinx-icon",
"sphinx-last-updated-by-git",
]

[tool.hatch.build.targets.wheel]
Expand Down

0 comments on commit 1a0b37b

Please sign in to comment.