Skip to content

Commit

Permalink
initial mock ups of new conda docs home page
Browse files Browse the repository at this point in the history
  • Loading branch information
travishathaway committed Nov 3, 2023
1 parent 8570910 commit f0bcc55
Show file tree
Hide file tree
Showing 7 changed files with 304 additions and 11 deletions.
2 changes: 0 additions & 2 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
@import url("theme.css");

.wy-nav-content {
padding: 1.618em 3.236em;
height: 100%;
Expand Down
84 changes: 84 additions & 0 deletions docs/source/_static/img/conda_logo.svg
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
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.
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>
</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 %}
11 changes: 11 additions & 0 deletions docs/source/_templates/navbar_center.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<ul id="navbar-main-elements" class="navbar-nav m-3">
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.conda.io/en/latest/conda.html">Conda</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.conda.io/en/latest/conda-build.html">Conda-build</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.conda.io/en/latest/miniconda.html">Miniconda</a>
</li>
</ul>
54 changes: 48 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,14 @@

# -- 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",
Expand All @@ -121,15 +123,57 @@
"source_suffix": ".rst",
}

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 = {
"logo": {
"text": ""
},
# logo is installed by mpl-sphinx-theme as:
# "logo": {"link": "https://matplotlib.org/stable/",
# "image_light": "_static/logo_light.svg",
# "image_dark": "_static/logo_dark.svg"},
# if this default is OK, then no need to modify "logo"
# collapse_navigation in pydata-sphinx-theme is slow, so skipped for local
# and CI builds https://github.com/pydata/pydata-sphinx-theme/pull/386
"show_prev_next": False,
# Determines the type of links produced in the navigation header:
# - absolute: Links point to the URL https://matplotlib.org/...
# - server-stable: Links point to top-level of the server /stable/...
# - internal: Links point to the internal files as expanded by the `pathto`
# template function in Sphinx.
"navbar_links": "absolute",

# Navbar icon links
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/conda-incubator/conda-sphinx-theme",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
},
{
"name": "Element",
"url": "http://bit.ly/conda-chat-room",
"icon": "_static/element_logo.svg",
"type": "local",
},
{
"name": "Discourse",
"url": "https://conda.discourse.group/",
"icon": "fa-brands fa-discourse",
"type": "fontawesome",
},
],

# Template settings
"navbar_center": ["navbar_center"],
"navbar_align": "left"
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand Down Expand Up @@ -209,8 +253,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
14 changes: 13 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
=====
Conda
conda
=====


.. figure:: /img/conda_logo.svg
:align: center
:width: 50%

..
.. grid::

.. grid-item-card:: A card with a dropdown menu

.. dropdown:: :fa:`eye me-1` Click to expand dropdown

Hidden content

.. grid-item-card:: A clickable card
:link: https://example.com

|
*Package, dependency and environment management for any
Expand Down
3 changes: 1 addition & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Sphinx
-e git+https://github.com/conda-incubator/conda-sphinx-theme.git@main#egg=conda_sphinx_theme
sphinx-sitemap==2.2.0
sphinx-rtd-theme
sphinx-design
sphinx-reredirects

0 comments on commit f0bcc55

Please sign in to comment.