Skip to content

Commit

Permalink
docs: Update dependencies and workaround further style issues
Browse files Browse the repository at this point in the history
  • Loading branch information
stotko committed Jun 19, 2024
1 parent 965a29f commit 3cd032b
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 4 deletions.
7 changes: 7 additions & 0 deletions docs/_static/extra_stylesheet.css
Original file line number Diff line number Diff line change
Expand Up @@ -2496,3 +2496,10 @@ html[data-theme=dark] .doxygen-content doxygen-awesome-dark-mode-toggle:hover {
html[data-theme=dark] .doxygen-content .tabs-overview button.tab-button:hover .tab-title {
color: var(--page-foreground-color);
}

/*
Alignment for Doxygen tables (eg: Modules)
*/
.doxygen-content .contents {
justify-content: left;
}
23 changes: 23 additions & 0 deletions docs/_static/stdgpu_custom_doxygen.css
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,26 @@
.doxygen-content .contents .memdoc {
margin-bottom: 10px;
}


/* Remove borders from tables */
.doxygen-content table,
.doxygen-content table td,
.doxygen-content td.mempage {
border: 0;
}


/* Fix buggy background color in documentation */
.doxygen-content table.memberdecls .memSeparator,
.doxygen-content td.mempage,
.doxygen-content table.memberdecls tr,
.doxygen-content table.params tr,
.doxygen-content table.tparams tr {
background-color: var(--pst-color-background) !important;
}

.doxygen-content table.memname tr,
.doxygen-content table.mlabels tr {
background-color: var(--fragment-background) !important;
}
23 changes: 23 additions & 0 deletions docs/_static/stdgpu_custom_sphinx.css
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,26 @@ footer.bd-footer-content {
--sd-color-tabs-overline: var(--pst-color-border) !important;
--sd-color-tabs-underline: var(--pst-color-border) !important;
}


/* Approximately replicated (somehow) broken style of tabs in sphinx-design */
.sd-tab-set,
.sd-tab-content,
.sd-tab-set > label {
background-color: var(--pst-color-background) !important;
}

.bd-content .sd-tab-set .sd-tab-content,
.bd-content .sd-tab-set > input:checked + label {
border: 0;
}

.sd-tab-content {
padding: 0 !important;
padding-bottom: .75rem !important;
padding-top: .75rem !important;
}

.bd-content .sd-tab-set > input:checked + label {
border-bottom: 0.125rem solid var(--pst-color-primary);
}
9 changes: 6 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@
myst_heading_anchors = 3

doxylink = {
"stdgpu": (str(pathlib.Path(__file__).parent / "doxygen" / "tagfile.xml"), "doxygen"),
"stdgpu": (
str(pathlib.Path(__file__).parent / "doxygen" / "tagfile.xml"),
"doxygen",
),
}


Expand Down Expand Up @@ -62,8 +65,8 @@
# Footer
"extra_footer": 'Made with <a href="https://www.sphinx-doc.org/">Sphinx</a>, <a href="https://www.doxygen.org/index.html">Doxygen</a>, <a href="https://boschglobal.github.io/doxysphinx/">Doxysphinx</a> and <a href="https://sphinx-book-theme.readthedocs.io/">sphinx-book-theme</a>, <a href="https://jothepro.github.io/doxygen-awesome-css/">Doxygen Awesome</a>',
# Code fragments
"pygment_light_style": "a11y-high-contrast-light", # same as in sphinx-book-theme
"pygment_dark_style": "a11y-dark",
"pygments_light_style": "a11y-high-contrast-light", # same as in sphinx-book-theme
"pygments_dark_style": "a11y-dark",
}

html_favicon = "_static/stdgpu_logo.ico"
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sphinx
sphinx-book-theme~=1.0.1
sphinx-book-theme
sphinx_copybutton
sphinx-design
sphinx-togglebutton
Expand Down

0 comments on commit 3cd032b

Please sign in to comment.