diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css index 95805e211..9ccfc85cf 100644 --- a/docs/source/_static/css/custom.css +++ b/docs/source/_static/css/custom.css @@ -1,5 +1,3 @@ -@import url("theme.css"); - .wy-nav-content { padding: 1.618em 3.236em; height: 100%; diff --git a/docs/source/_static/img/conda_logo.svg b/docs/source/_static/img/conda_logo.svg new file mode 100644 index 000000000..48f77413e --- /dev/null +++ b/docs/source/_static/img/conda_logo.svg @@ -0,0 +1,84 @@ + + + + logo_conda_RGB_inkscape + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html new file mode 100644 index 000000000..57721f976 --- /dev/null +++ b/docs/source/_templates/index.html @@ -0,0 +1,147 @@ +{% extends "!layout.html" %} + +{% block body %} + +
+
+

Conda Documentation

+

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

+ +

Install

+
+ + +
+
Download and run the installer:
+

+ Miniconda3 Windows 64-bit +

+
+ + + +
+
Download and run the installer:
+ + + + + + + + + + + +
+ Apple Intel x86 64-bit + + Apple M1 64-bit +
+ Miniconda3 macOS Intel x86 64-bit pkg + + Miniconda3 macOS Apple M1 64-bit pkg +
+
+ + + +
+
Download and run the installer
+ 
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
+
+
+
+

For more detailed instructions, see the Installation Guide.

+
+ +
+
+

Learn

+
+
+ +
+
+
+
+ Getting started +
+
+

Learn how to get started using conda with a tutorials and quick start guides

+
+ Example +
+
+
+
+
+ Package search +
+
+

Learn how to build and distribute your software with conda

+
+ Example +
+
+
+
+
+ Commands +
+
+

Learn how to use the most import conda commands and read relevant help pages

+
+ Example +
+
+
+
+
+
+
+ Building Packages +
+
+

Learn how to build and distribute your software with conda

+
+ Example +
+
+
+
+
+ What's new? +
+
+

Check out our blog for the latest release notes and other news

+
+ Example +
+
+
+
+
+ Developer guide +
+
+

Take deep dives into advanced topics

+
+ Example +
+
+
+ +{% endblock %} \ No newline at end of file diff --git a/docs/source/_templates/navbar_center.html b/docs/source/_templates/navbar_center.html new file mode 100644 index 000000000..89de3e35a --- /dev/null +++ b/docs/source/_templates/navbar_center.html @@ -0,0 +1,11 @@ + diff --git a/docs/source/conf.py b/docs/source/conf.py index 3b156fba1..3bfb25c19 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", @@ -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 = [] @@ -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 = { diff --git a/docs/source/index.rst b/docs/source/index.rst index e287477c0..107b53afd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 diff --git a/requirements.txt b/requirements.txt index e7f7cda9d..0d024cb14 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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