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.

Sign up for GitHub

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

Adding conda-sphinx-theme and redesign of front page #900

Merged
merged 17 commits into from
Nov 28, 2023
Merged

Adding conda-sphinx-theme and redesign of front page #900

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
f0bcc55
initial mock ups of new conda docs home page
travishathaway Nov 3, 2023
5541555
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 3, 2023
1b07ab1
hopefully fixing the readthedocs configuration
travishathaway Nov 3, 2023
6ccc92a
Merge branch 'new-sphinx-theme' of https://github.com/conda/conda-doc…
travishathaway Nov 3, 2023
3d974df
hopefully fixing the readthedocs configuration
travishathaway Nov 3, 2023
b50e07e
updating readthedocs
travishathaway Nov 3, 2023
14c9908
updating readthedocs
travishathaway Nov 3, 2023
eca1a81
updates for readthedocs
travishathaway Nov 3, 2023
30691ab
updates for readthedocs
travishathaway Nov 3, 2023
7872538
trying a different python version for readthedocs
travishathaway Nov 6, 2023
2f1bd7c
updates to layout
travishathaway Nov 13, 2023
18b5f8b
Merge branch 'main' into new-sphinx-theme
travishathaway Nov 13, 2023
c6cda40
adding news file
travishathaway Nov 13, 2023
dd5ccc6
adding updates to landing page
travishathaway Nov 15, 2023
bece745
Apply suggestions from code review
travishathaway Nov 20, 2023
06de538
updates to conf.py and requirements
travishathaway Nov 20, 2023
24d42f9
updating landing page
travishathaway Nov 20, 2023
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
83 changes: 2 additions & 81 deletions docs/source/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,83 +1,4 @@
@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;
}

.wy-side-nav-search {
/*background color of the top search bar*/
background-color: #43B02A;
}

.wy-nav-side {
/* This relates to the entire color of the sidebar */
background-color:#EEEEEE;
}

.wy-menu a:hover {
/*background color of text upon hovering*/
background: #c9c9c9
}

.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
}

.wy-menu-vertical {
/* text color of expanded menu items in the sidebar */
color:#414042;
}

.section h1 {
/*header 1 text color */
color: #047704;
}

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

.wy-menu-vertical a {
/* Text color of toc */
color: #025C02;
}

.wy-nav-content-wrap {
/* background color of wrap around main content*/
background-color: white;
}

.section-title {
/*text color of section titles*/
color:#078E07;
}

.rst-content pre.literal-block, .rst-content div[class^='highlight'] pre, .rst-content .linenodiv pre {
/*color of code blocks*/
background-color: #EEEEEE
}

h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
/*font formats*/
font-family: "Proxima Nova","Helvetica","Arial",sans-serif;
}
.wy-menu-vertical li.toctree-l1.current>a {
/*text color of toctree*/
color: #025C02;
}

.toctree-l1:hover {
background-color: #EEEEEE;
}

.wy-nav-top {
/*color of nav at top when the window is narrow*/
background: #43B02A;
#conda-documentation .sd-tab-content {
min-height: 9rem;
}
84 changes: 84 additions & 0 deletions docs/source/_static/img/conda_logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
147 changes: 147 additions & 0 deletions docs/source/_templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{% extends "!layout.html" %}

{% block body %}

<div class="row mt-2">
<div class="col-12">
<h1>Conda Documentation</h1>
<p>
Conda provides package, dependency and environment management for any language.
travishathaway marked this conversation as resolved.
Show resolved Hide resolved
The following documentation site provides all you need to get started with
leveraging the power of conda.
</p>

<h2>Install</h2>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-1" name="sd-tab-set-2" type="radio" />
<label class="sd-tab-label" data-sync-id="key1" for="sd-tab-item-1">
Windows
</label>
<div class="sd-tab-content docutils">
<h5>Download and run the installer:</h5>
<p>
<a class="reference external" href="https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe">Miniconda3 Windows 64-bit</a>
</p>
</div>

<input id="sd-tab-item-2" name="sd-tab-set-2" type="radio" />
<label class="sd-tab-label" data-sync-id="key2" for="sd-tab-item-2">
MacOS
</label>
<div class="sd-tab-content docutils">
<h5>Download and run the installer:</h5>
<table class="table">
<thead>
<th>
Apple Intel x86 64-bit
</th>
<th>
Apple M1 64-bit
</th>
</thead>
<tbody>
<tr>
<td>
<a class="reference external" href="https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.pkg">Miniconda3 macOS Intel x86 64-bit pkg</a>
</td>
<td>
<a class="reference external" href="https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg">Miniconda3 macOS Apple M1 64-bit pkg</a>
</td>
</tr>
</tbody>
</table>
</div>

<input id="sd-tab-item-3" name="sd-tab-set-2" type="radio" />
<label class="sd-tab-label" data-sync-id="key2" for="sd-tab-item-3">
Linux
</label>
<div class="sd-tab-content docutils">
<h5 class="mt-1">Download and run the installer</h5>
<pre>curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
~/miniconda3/bin/conda init bash</pre>
</div>
</div>
</div>
<p>For more detailed instructions, see the <a href="#">Installation Guide</a>.</p>
</div>

<div class="row">
<div class="col-12">
<h2>Learn</h2>
</div>
</div>

<div class="row mb-5">
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
Getting started
</div>
<div class="card-body">
<p class="card-text">Learn how to get started using conda with a tutorials and quick start guides</p>
travishathaway marked this conversation as resolved.
Show resolved Hide resolved
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
Package search
</div>
<div class="card-body">
<p class="card-text">Learn how to build and distribute your software with conda</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
Commands
</div>
<div class="card-body">
<p class="card-text">Learn how to use the most import conda commands and read relevant help pages</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
</div>
<div class="row">
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
Building Packages
</div>
<div class="card-body">
<p class="card-text">Learn how to build and distribute your software with conda</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
What's new?
</div>
<div class="card-body">
<p class="card-text">Check out our blog for the latest release notes and other news</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
<div class="col-4">
<div class="sd-card card sd-card-hover mt-2 mr-2 front-page-card sd-shadow-sm sd-sphinx-override sd-shadow-sm docutils">
<div class="card-header text-bg-primary">
Developer guide
</div>
<div class="card-body">
<p class="card-text">Take deep dives into advanced topics</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="#"><span>Example</span></a>
</div>
</div>
</div>

{% endblock %}
44 changes: 35 additions & 9 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
master_doc = "index"

# General information about the project.
project = "conda"
project = "conda-docs"
copyright = "2017, Anaconda, Inc."

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -105,31 +105,55 @@

# -- Options for HTML output ---------------------------------------------------

# html_additional_pages = {"index": "index.html"}

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# extensions += ['sphinxjp.themes.basicstrap']
# html_theme = 'basicstrap'

html_theme = "sphinx_rtd_theme"
html_theme = "conda_sphinx_theme"

html_context = {
"github_user": "conda",
"github_repo": "conda-docs",
"github_version": "master/",
"github_version": "main",
"display_github": True,
"conf_py_path": "docs/source/",
"source_suffix": ".rst",
"doc_path": "docs/source",
}

html_favicon = "conda-logo.png"

# Serving the robots.txt since we want to point to the sitemap.xml file
html_extra_path = ["robots.txt"]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {
"show_prev_next": False,
"use_edit_page_button": True,
"primary_sidebar_end": [],
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/conda/conda-docs",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
},
{
"name": "Element",
"url": "https://matrix.to/#/#conda:matrix.org",
"icon": "_static/element_logo.svg",
"type": "local",
},
{
"name": "Discourse",
"url": "https://conda.discourse.group/",
"icon": "fa-brands fa-discourse",
"type": "fontawesome",
},
],
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand All @@ -155,6 +179,10 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

html_css_files = [
"css/custom.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
Expand Down Expand Up @@ -209,8 +237,6 @@
# Output file base name for HTML help builder.
htmlhelp_basename = "condadoc"

html_style = "css/custom.css"

# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
Expand Down
Loading