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

Update doc theme #402

Merged
merged 11 commits into from
Jun 16, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
14 changes: 7 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ jobs:
- uses: conda-incubator/setup-miniconda@v2
with:
auto-update-conda: false
miniconda-version: py37_4.10.3
miniconda-version: "latest"
auto-activate-base: true
activate-environment: ""
- name: Install build dependencies
shell: bash -l {0}
shell: bash -el {0}
run: |
conda config --append channels conda-forge
conda install -y conda-build conda-verify flake8 pydocstyle yapf==0.30.0 sphinx sphinx_rtd_theme
conda install -y conda-build conda-verify flake8 pydocstyle yapf==0.30.0 sphinx pydata-sphinx-theme==0.14.4 sphinx-copybutton sphinx-notfound-page
- name: Verify formatting compliance
shell: bash -l {0}
shell: bash -el {0}
run: |
if ! yapf --diff --recursive anaconda_project; then
echo "----"
Expand All @@ -39,15 +39,15 @@ jobs:
flake8 anaconda_project
pydocstyle anaconda_project
- name: Build the documentation as a test
shell: bash -l {0}
shell: bash -el {0}
run: |
cd docs
make html
- name: Build the package
shell: bash -l {0}
shell: bash -el {0}
run: conda build --no-test conda.recipe
- name: Reduce the size of the build artifact
shell: bash -l {0}
shell: bash -el {0}
run: rm -rf ${CONDA}/conda-bld/{git_cache,work,anaconda-project*,*/.cache}
- name: Upload the build artifact
uses: actions/upload-artifact@v2
Expand Down
2 changes: 1 addition & 1 deletion anaconda_project/internal/test/test_streaming_popen.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def detect_linesep(lines):

def add_lineseps(lines, sep=None):
sep = sep or os.linesep
return list(map(lambda l: l + sep, lines))
return list(map(lambda line: line + sep, lines))


def test_streaming():
Expand Down
7 changes: 6 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
name: anaconda-project-docs
dependencies:
- sphinx
- sphinx_rtd_theme
- pydata-sphinx-theme=0.14.4
- sphinx-copybutton
- sphinx-notfound-page
channels:
- defaults
- conda-forge
6 changes: 6 additions & 0 deletions docs/source/404.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:orphan:

404
===

Error 404: Page not found. You may have gone to the wrong page or this page was moved or deleted. Please visit https://anaconda-project.readthedocs.io/en/latest/ for the latest version of the documentation.
Binary file added docs/source/_static/Anaconda_Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
168 changes: 113 additions & 55 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,83 +1,141 @@
@import url("theme.css");

.wy-nav-content {
padding: 1.618em 3.236em;
height: 100%;
max-width: 1500px;
/* max-width: 800px; */
margin: auto;
background-color: #ffffff;
/* Changed default colors of theme to match anaconda.com's greens.
Also changed warning admonition from default orange to red and
added caution admonition orange coloring. */

html[data-theme="light"] {
--pst-color-primary: #43b049;
--pst-color-secondary-highlight: #0ccb4a;
--pst-color-link-hover: #0ccb4a;
--pst-color-caution: #ee9040;
--pst-color-caution-text: #fff;
--pst-color-caution-highlight: #cf6912;
--pst-color-caution-bg: #f8e5d0;
--pst-color-warning: #dc3545;
--pst-color-warning-text: #fff;
--pst-color-warning-highlight: #a71d2a;
--pst-color-warning-bg: #f8d0d0;
--sd-color-card-border-hover: var(--pst-color-primary);
--pst-heading-color: var(--pst-color-primary);
}

.wy-side-nav-search {
/*background color of the top search bar*/
background-color: #43B02A;
html[data-theme="dark"] {
--pst-color-primary: #43b049;
--pst-color-secondary-highlight: #0ccb4a;
--pst-color-link-hover: #0ccb4a;
--pst-color-caution: #ee9040;
--pst-color-caution-text: #fff;
--pst-color-caution-highlight: #cf6912;
--pst-color-caution-bg: #654402;
--pst-color-warning: #cb4653;
--pst-color-warning-text: #fff;
--pst-color-warning-highlight: #992b36;
--pst-color-warning-bg: #650202;
--sd-color-card-border-hover: var(--pst-color-primary);
--pst-heading-color: var(--pst-color-primary);
}

.wy-nav-side {
/* This relates to the entire color of the sidebar */
background-color:#EEEEEE;
a.headerlink {
color: #0ccb4a !important;
}

.wy-menu a:hover {
/*background color of text upon hovering*/
background: #c9c9c9
/* Updates the dropdown color to be the same green as the tip admonition*/

details.sd-dropdown summary.sd-card-header.sd-bg-primary, details.sd-dropdown summary.sd-card-header.sd-bg-primary+div.sd-summary-content {
--pst-sd-dropdown-bg-color: var(--pst-color-success-bg);
}

.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover {
/*background color of text upon hovering an open list*/
background: #c9c9c9
/* Adds side margins to inline Sphinx Design icons in dropdowns*/

details.sd-dropdown summary.sd-card-header svg {
margin-left: 4px;
margin-right: 4px;
}

.wy-menu-vertical {
/* text color of expanded menu items in the sidebar */
color:#414042;
/* Inserting Inter and Poppins fonts (found in the _static/fonts
folder) into the docs. The Inter font doesn't have an italic, so
Helvetica is a compromise. */

body {
--pst-font-family-base: "Inter", "Helvetica", Arial, sans-serif;
font-weight: 400;
}

.section h1 {
/*header 1 text color */
color: #047704;
.heading-style, h1, h2, h3, h4, h5, h6 {
--pst-font-family-heading: "Poppins", "Helvetica Neue", Arial, sans-serif;
--pst-font-weight-heading: 600;
}

.rst-content .toctree-wrapper p.caption, h2, h3, h4, h5, h6, legend {
/*text color of rst content and subheads*/
color: #414042;

strong {
font-weight: 600;
}

em {
font-family: "Helvetica" !important;
font-style: italic;
}

/* Added new caution color (orange) to caution admonitions. By default, they use
--pst-color-warning, which has been changed to red above.*/

.admonition.caution>.admonition-title:before, div.admonition.caution>.admonition-title:before {
background-color: var(--pst-color-caution-bg);
}

.wy-menu-vertical a {
/* Text color of toc */
color: #025C02;
.admonition.caution>.admonition-title:after, div.admonition.caution>.admonition-title:after {
color: var(--pst-color-caution);
}

.wy-nav-content-wrap {
/* background color of wrap around main content*/
background-color: white;
.admonition.caution, div.admonition.caution {
border-color: var(--pst-color-caution);
}

.section-title {
/*text color of section titles*/
color:#078E07;
/* Removing blockquote css because it isn't used in the
Anaconda docs and makes it impossible to have a note,
admonition, or second-level list in the middle of an
ordered list. */

blockquote, blockquote p {
border-left: none;
border-radius: 0;
padding: 0;
background-color: transparent;
}

.rst-content pre.literal-block, .rst-content div[class^='highlight'] pre, .rst-content .linenodiv pre {
/*color of code blocks*/
background-color: #EEEEEE
/* This fixes an issue where the scrollbar on the left side nav
appears when it doesn't need to by reducing the size of the
div below the sidebar nav. */

.bd-sidebar-primary .sidebar-primary-items__end {
margin-top: 1em
}

h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
/*font formats*/
font-family: "Proxima Nova","Helvetica","Arial",sans-serif;
/*Controls coloring of built-in announcement banner. These can
be created using html_theme_options = {"announcement": "Here's
an announcement."}*/

.bd-header-announcement {
background-color: var(--pst-color-primary);
color: white
}
.wy-menu-vertical li.toctree-l1.current>a {
/*text color of toctree*/
color: #025C02;

/* Adds a little padding to the bottom of tab set divs inside other tab sets, in
case there is a paragraph of text right after them. Without this
the text is a little too close to the horizontal line that ends
the secondary tab set*/

.sd-tab-content>.sd-tab-set {
margin-bottom: 10px;
}

.toctree-l1:hover {
background-color: #EEEEEE;
/*Removing hover underline from nav elements*/

.bd-header .navbar-nav li.current a.nav-link:hover {
text-decoration: none;
}

.wy-nav-top {
/*color of nav at top when the window is narrow*/
background: #43B02A;
}
/*Changing outline of search form color*/

.form-control:focus, .form-control:focus-visible {
outline: 3px solid var(--pst-color-primary);
box-shadow: 0 0 0 0.25rem rgba(67,176,73,.25);
}
Binary file added docs/source/_static/favicon.ico
Binary file not shown.
Binary file not shown.
93 changes: 93 additions & 0 deletions docs/source/_static/fonts/Inter/OFL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
Loading
Loading