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

Try switching themes #61

Merged
merged 19 commits into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/requirements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ dependencies:
- python
- pip

- sphinx==5.3.0
- sphinx_rtd_theme
- sphinx

- pyyaml
- pydantic
Expand All @@ -19,3 +18,5 @@ dependencies:
# Pip-only installs
- pip:
- PyGithub
- git+https://github.com/MDAnalysis/mdanalysis-sphinx-theme.git@update-theme

2 changes: 1 addition & 1 deletion docs/scripts/gen_mdakits.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def generate_mdakit_index(target='.', excludedirs=["template",]):
" 2. Provide sufficient details to allow others to use and "
"potentially participate in the development of the MDAKits\n"
" 3. Provide information about the current state of the MDAKits "
"and how they interact with the latest versions of MDAnalysis\n"
"and how they interact with the latest versions of MDAnalysis\n\n"
"Each of the MDAKits in the following table links to a page with "
"more details about what the MDAKits do, how they can be "
"installed and how to participate in their development.\n")
Expand Down
226 changes: 2 additions & 224 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -1,225 +1,3 @@
/* override css for readable.css */

/* styles/fonts to match http://mdanalysis.org (see public/css) */
/* MDAnalysis orange: #FF9200 */
/* MDAnalysis gray: #808080 */
/* MDAnalysis white: #FFFFFF */
/* MDAnalysis black: #000000 */
/* Very light orange: #FFEBD0 */
/* Code orange: #ca6500 */
/* RTD dark grey: #343131 */
/* RTD light grey: #e6e6e6 */

/* -- page layout --------------------------------------------------------- */

body {
font-family: 'PT Sans', Helvetica, Arial, 'sans-serif';
font-size: 17px;
.dataTables_wrapper.no-footer .wy-table-responsive {
overflow: unset;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This from seems to do the trick in making sure the table isn't horribly squashed: readthedocs/sphinx_rtd_theme#1287 (comment)

I suspect this isn't something we'd want to upstream since we don't really use dataTables anywhere else in the ecosystem?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm I reckon we should upstream this! It's unlikely it'd affect anything else and if we do want to use datatables in the future, I assume we'd want to apply the same styling. Also it seems like a pity to keep this file just for this part.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added as a commit for now -- of course I can revert if you disagree!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers, let's see if that does the trick.

}

div.body {
color: #000000;
}

div.sphinxsidebar a:hover {
text-decoration: none !important;
}

div.sphinxsidebar p {
color: #808080;
}

/* Home MDAnalysis colour */
.wy-side-nav-search > a {
color: #343131;
}

/* Side MDAnalysis version colour */
.wy-side-nav-search > div.version {
color: #808080;
}

/* Menubar caption colour */
div.wy-menu-vertical span.caption-text {
color: #FF9200;
}

/* Mobile layout menubar option */
nav.wy-nav-top {
background: #343131;
}

/* Menu search bar outline (default blue) */
.wy-side-nav-search input[type="text"] {
border-color: #808080;
}


/* -- body styles --------------------------------------------------------- */

/* Different coloured links for sidebar vs body) */
div.rst-content a {
color: #FF9200;
text-decoration: none;
}

div.rst-content a:visited {
color: #FF9200;
}

a:hover {
color: #FF9200 !important;
text-decoration: underline;
}


pre, tt, code {
font-family: Menlo, Monaco, 'Courier New', monospace
}


div.body h1 {
font-weight: bolder;
}

a.headerlink {
color: #808080;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}

a.headerlink:hover {
background-color: #808080;
color: #fff;
}

/* ------- admonition boxes ------- */

div.admonition {
margin: 10px 0px;
padding: 10px 10px;
}

div.admonition p.admonition-title {
font-size: 100%;
font-weight: bolder;
}

/* ----- Tables ----- */

/* override table width restrictions */
/* wrap tables instead of scrolling */
@media screen and (min-width: 767px) {

.wy-table-responsive table td, .wy-table-responsive table th {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}

.wy-table-responsive {
overflow: visible !important;
max-width: 100% !important;
}
}

/* ----- Field lists ------ */

.section > dl.field-list {
display: flex;
flex-wrap: wrap;
margin: 0;
padding: 0;
}

dl.field-list > dt::after {
content: ":";
}

.rst-content dl:not(.docutils) dt {
background: none;
color: #000000;
border-top: none;
}

.section > dl.field-list dt {
margin: 0;
padding: 0;
flex-basis: 20%;
display: block;
}

.section > dl.field-list > dd {
flex-basis: 70%;
margin: 0;
}

.section > dl.field-list > dd p {
margin: 0;
}

/* ----- MDAnalysis coloured elements ------ */

.rst-content dl.class dt, .rst-content dl.function dt {
color: #ca6500;
background: #FFEBD0;
border-top: solid 3px #FF9200;
}

.rst-content .viewcode-link, .rst-content .viewcode-back {
color: #808080;
}

.rst-content .guilabel {
background: #efefef;
border: 1px solid #808080;
}


.rst-content .seealso p.admonition-title {
background: #808080;
}

.rst-content .seealso {
background: #e3e3e3;
}

.rst-content .error p.admonition-title, .rst-content .warning p.admonition-title {
background: #F45F4B;
}

.rst-content .error, .rst-content .warning {
background: #FFEEED;
}

.rst-content .caution p.admonition-title, .rst-content .note p.admonition-title, .rst-content .important p.admonition-title {
background: #FF9200;
}

.rst-content .caution, .rst-content .note, .rst-content .important {
background: #FFEBD0;
}

.rst-content code:not(.xref).literal {
color: #ca6500;
}
/* override table width restrictions */
@media screen and (min-width: 767px) {

.wy-table-responsive table td, .wy-table-responsive table th {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}

.wy-table-responsive {
overflow: visible !important;
max-width: 100% !important;
}
}

dl.footnote p {
font-weight: lighter;
font-size: 14px
}
Loading
Loading