From f0bcc55436201a1822fec51058b4a788acfe9c71 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 14:41:46 +0100 Subject: [PATCH 01/15] initial mock ups of new conda docs home page --- docs/source/_static/css/custom.css | 2 - docs/source/_static/img/conda_logo.svg | 84 +++++++++++++ docs/source/_templates/index.html | 147 ++++++++++++++++++++++ docs/source/_templates/navbar_center.html | 11 ++ docs/source/conf.py | 54 +++++++- docs/source/index.rst | 14 ++- requirements.txt | 3 +- 7 files changed, 304 insertions(+), 11 deletions(-) create mode 100644 docs/source/_static/img/conda_logo.svg create mode 100644 docs/source/_templates/index.html create mode 100644 docs/source/_templates/navbar_center.html 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 From 5541555820e82204b3cf10a6c8eed389b7ff57e4 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 3 Nov 2023 13:45:27 +0000 Subject: [PATCH 02/15] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/_templates/index.html | 2 +- docs/source/conf.py | 10 +++------- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html index 57721f976..9f0005363 100644 --- a/docs/source/_templates/index.html +++ b/docs/source/_templates/index.html @@ -144,4 +144,4 @@

Learn

-{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 3bfb25c19..a8c1260af 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -105,7 +105,7 @@ # -- Options for HTML output --------------------------------------------------- -html_additional_pages = {'index': 'index.html'} +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. @@ -130,9 +130,7 @@ # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - "logo": { - "text": "" - }, + "logo": {"text": ""}, # logo is installed by mpl-sphinx-theme as: # "logo": {"link": "https://matplotlib.org/stable/", # "image_light": "_static/logo_light.svg", @@ -147,7 +145,6 @@ # - internal: Links point to the internal files as expanded by the `pathto` # template function in Sphinx. "navbar_links": "absolute", - # Navbar icon links "icon_links": [ { @@ -169,10 +166,9 @@ "type": "fontawesome", }, ], - # Template settings "navbar_center": ["navbar_center"], - "navbar_align": "left" + "navbar_align": "left", } # Add any paths that contain custom themes here, relative to this directory. From 1b07ab1bcc89206f585b2d63e8721c058936da4d Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 14:46:22 +0100 Subject: [PATCH 03/15] hopefully fixing the readthedocs configuration --- .readthedocs.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 89f1b2ddd..a084b830c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,7 +1,11 @@ version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.8" + python: - version: "3" install: - requirements: requirements.txt From 3d974dfc9d220fe336a18b240d3c5ca03af43b61 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 14:48:58 +0100 Subject: [PATCH 04/15] hopefully fixing the readthedocs configuration --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a084b830c..8a96df77d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,4 +12,4 @@ python: # Additional (downloadable) formats of the documentation to be built, apart # from the default HTML. formats: -- htmlzip +- htmldir From b50e07eaa0afca22854c7d086c731afcf068cd3d Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 14:50:18 +0100 Subject: [PATCH 05/15] updating readthedocs --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 8a96df77d..a084b830c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,4 +12,4 @@ python: # Additional (downloadable) formats of the documentation to be built, apart # from the default HTML. formats: -- htmldir +- htmlzip From 14c9908fc51b80ae59339c6a806f1b8b255ceef5 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 14:55:58 +0100 Subject: [PATCH 06/15] updating readthedocs --- .readthedocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index a084b830c..acdbcb81f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,3 +13,6 @@ python: # from the default HTML. formats: - htmlzip + +sphinx: + builder: dirhtml From eca1a81166571de9076c1103caf78ea55d95b25e Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 15:13:33 +0100 Subject: [PATCH 07/15] updates for readthedocs --- .readthedocs.yml | 3 --- docs/source/index.rst | 57 ------------------------------------------- 2 files changed, 60 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index acdbcb81f..a084b830c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,6 +13,3 @@ python: # from the default HTML. formats: - htmlzip - -sphinx: - builder: dirhtml diff --git a/docs/source/index.rst b/docs/source/index.rst index 107b53afd..d6da4d6e7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,63 +2,6 @@ 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 -language---Python, R, Ruby, Lua, Scala, Java, JavaScript, C/ C++, -Fortran, and more.* - -Conda is an open source package management system and environment -management system that runs on Windows, macOS, and Linux. Conda -quickly installs, runs and updates packages and their dependencies. -Conda easily creates, saves, loads and switches between environments -on your local computer. It was created for Python programs, but it -can package and distribute software for any language. - -Conda as a package manager helps you find and install packages. -If you need a package that requires a different version of -Python, you do not need to switch to a different environment -manager, because conda is also an environment manager. With just -a few commands, you can set up a totally separate environment to -run that different version of Python, while continuing to run -your usual version of Python in your normal environment. - -In its default configuration, conda can install and manage the -thousand packages at `repo.anaconda.com `_ that are built, reviewed -and maintained by Anaconda\ |reg|. - -Conda can be combined with continuous integration systems such -as Travis CI and AppVeyor to provide frequent, automated testing -of your code. - -The conda package and environment manager is included in all versions of -Anaconda and Miniconda. - -Conda is also included in `Anaconda Enterprise -`_, which provides on-site enterprise -package and environment management for Python, R, Node.js, Java and other -application stacks. Conda is also available on `conda-forge `_, -a community channel. You may also get conda on `PyPI `_, -but that approach may not be as up to date. - .. toctree:: :hidden: :maxdepth: 1 From 30691ab213e0a737d7817eb6fd570cdf4e80ed90 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Fri, 3 Nov 2023 16:01:39 +0100 Subject: [PATCH 08/15] updates for readthedocs --- docs/source/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d6da4d6e7..20e88f33e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,5 +12,3 @@ conda help-support contributing license - -.. |reg| unicode:: U+000AE .. REGISTERED SIGN From 78725385470fc35cc6d05cf878a024a94f54c232 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 6 Nov 2023 12:03:24 +0100 Subject: [PATCH 09/15] trying a different python version for readthedocs --- .readthedocs.yml | 2 +- docs/source/index.rst | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a084b830c..bc77d507c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,7 +3,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.8" + python: "3.11" python: install: diff --git a/docs/source/index.rst b/docs/source/index.rst index 20e88f33e..d6da4d6e7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,3 +12,5 @@ conda help-support contributing license + +.. |reg| unicode:: U+000AE .. REGISTERED SIGN From 2f1bd7c298cc0448b48bc59c254dd40c7ab777ea Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 13 Nov 2023 13:16:06 +0100 Subject: [PATCH 10/15] updates to layout --- docs/source/_templates/navbar_center.html | 11 ------- docs/source/conf.py | 40 ++--------------------- docs/source/index.rst | 3 -- 3 files changed, 2 insertions(+), 52 deletions(-) delete mode 100644 docs/source/_templates/navbar_center.html diff --git a/docs/source/_templates/navbar_center.html b/docs/source/_templates/navbar_center.html deleted file mode 100644 index 89de3e35a..000000000 --- a/docs/source/_templates/navbar_center.html +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/docs/source/conf.py b/docs/source/conf.py index a8c1260af..fbe7a2479 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 @@ -130,45 +130,9 @@ # further. For a list of options available for each theme, see the # documentation. 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", + "primary_sidebar_end": [], } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/source/index.rst b/docs/source/index.rst index d6da4d6e7..dcc096d9b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,9 +6,6 @@ conda :hidden: :maxdepth: 1 - conda - conda-build - miniconda help-support contributing license From c6cda40c5db2be03b853c24f12e88aabe87f28b4 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 13 Nov 2023 13:18:50 +0100 Subject: [PATCH 11/15] adding news file --- news/900-use-conda-sphinx-theme | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 news/900-use-conda-sphinx-theme diff --git a/news/900-use-conda-sphinx-theme b/news/900-use-conda-sphinx-theme new file mode 100644 index 000000000..18294918a --- /dev/null +++ b/news/900-use-conda-sphinx-theme @@ -0,0 +1,20 @@ +### Enhancements + +* Redesign of the landing page +* Usage of new conda-sphinx-theme + +### Bug fixes + +* + +### Deprecations + +* + +### Docs + +* + +### Other + +* From dd5ccc6d47d4b583fe3df3645309331f614fde5c Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Wed, 15 Nov 2023 11:27:35 +0100 Subject: [PATCH 12/15] adding updates to landing page --- docs/source/_static/css/custom.css | 81 +----------------- docs/source/conf.py | 32 ++++++- docs/source/index.rst | 130 ++++++++++++++++++++++++++++- 3 files changed, 158 insertions(+), 85 deletions(-) diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css index 9ccfc85cf..38ccc6594 100644 --- a/docs/source/_static/css/custom.css +++ b/docs/source/_static/css/custom.css @@ -1,81 +1,4 @@ -.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; } diff --git a/docs/source/conf.py b/docs/source/conf.py index fbe7a2479..00a92838d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -105,7 +105,7 @@ # -- Options for HTML output --------------------------------------------------- -html_additional_pages = {"index": "index.html"} +# 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. @@ -117,10 +117,10 @@ 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", } # Serving the robots.txt since we want to point to the sitemap.xml file @@ -131,8 +131,28 @@ # documentation. html_theme_options = { "show_prev_next": False, - "navbar_links": "absolute", + "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. @@ -159,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' diff --git a/docs/source/index.rst b/docs/source/index.rst index dcc096d9b..9ee9be4dd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,132 @@ +=================== +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 :octicon:`download;1em;sd-text-primary` +================================================ + +We recommend the following methods to install conda: + +.. tab-set:: + + .. tab-item:: Windows :fab:`windows` + + Miniconda installer for: + + .. grid:: 2 + + .. grid-item:: + + .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe + :color: primary + + Windows x86 64-bit :octicon:`download` + + .. tab-item:: MacOS :fab:`apple` + + Miniconda installer for: + + .. grid:: 2 + + .. grid-item:: + + .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.pkg + :color: primary + + MacOS x86 64-bit :octicon:`download` + + .. grid-item:: + + .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg + :color: primary + + MacOS M1 64-bit :octicon:`download` + + .. tab-item:: Linux :fab:`linux` + + Miniconda installer for: + + .. grid:: 2 + + .. grid-item:: + + .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh + :color: primary + + Linux x86 64-bit :octicon:`download` + + .. tab-item:: Homebrew :fa:`beer-mug-empty` + + Run the following `Homebrew `_ command: + + .. code-block:: bash + + brew install miniconda + + .. tab-item:: Chocolatey :octicon:`terminal` :fab:`windows` + + Run the following `Chocolatey `_ command: + + .. code-block:: bash + + choco install miniconda3 + + +.. raw:: html + +

For more detailed instructions, see Miniconda's installation guide

+ +Learn ===== -conda -===== + +.. grid:: 1 2 2 2 + + .. grid-item:: + + .. card:: Getting started :octicon:`rocket;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html + + Learn how to get started using conda with a tutorials and quick start guides + + .. grid-item:: + + .. card:: Package search :octicon:`search;1em;sd-text-primary` + :link: https://anaconda.org + + Find all the packages for your project on `anaconda.org `_ + + .. grid-item:: + + .. card:: Commands :octicon:`terminal;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda/en/stable/commands/index.html + + Documentation for all essential conda commands + + .. grid-item:: + + .. card:: Building Packages :octicon:`package;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda-build/en/stable/index.html + + Learn how to build and distribute your software with conda + + .. grid-item:: + + .. card:: What's new? :octicon:`globe;1em;sd-text-primary` + :link: https://conda.org/blog + + Check out our blog for the latest release notes and other news + + .. grid-item:: + + .. card:: Developer guide :octicon:`file-code;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda/en/stable/dev-guide/index.html + + Take deep dives into advanced topics on the internal workings of conda + .. toctree:: :hidden: From bece745b9cce646f3f02890976a592b9ca70c659 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 20 Nov 2023 12:18:49 +0100 Subject: [PATCH 13/15] Apply suggestions from code review Co-authored-by: Katherine Kinnaman --- docs/source/_templates/index.html | 4 ++-- docs/source/index.rst | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html index 9f0005363..1e3fbb645 100644 --- a/docs/source/_templates/index.html +++ b/docs/source/_templates/index.html @@ -6,7 +6,7 @@

Conda Documentation

- Conda provides package, dependency and environment management for any language. + 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.

@@ -80,7 +80,7 @@

Learn

Getting started
-

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

+

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

Example diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ee9be4dd..bd9f85b32 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,11 +2,11 @@ Conda Documentation =================== -Conda provides package, dependency and environment management for any language. +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 :octicon:`download;1em;sd-text-primary` +Install :octicon:`download;1em;sd-text-primary` ================================================ We recommend the following methods to install conda: @@ -90,7 +90,7 @@ Learn .. card:: Getting started :octicon:`rocket;1em;sd-text-primary` :link: https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html - Learn how to get started using conda with a tutorials and quick start guides + Learn how to get started using conda with tutorials and quick start guides .. grid-item:: From 06de538e0e67e486fb2d01567ad943c443098abb Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 20 Nov 2023 12:20:35 +0100 Subject: [PATCH 14/15] updates to conf.py and requirements --- docs/source/_templates/index.html | 147 ------------------------------ docs/source/conf.py | 7 +- requirements.txt | 2 +- 3 files changed, 2 insertions(+), 154 deletions(-) delete mode 100644 docs/source/_templates/index.html diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html deleted file mode 100644 index 1e3fbb645..000000000 --- a/docs/source/_templates/index.html +++ /dev/null @@ -1,147 +0,0 @@ -{% 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 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 %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 00a92838d..fd0867a6f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -133,13 +133,8 @@ "show_prev_next": False, "use_edit_page_button": True, "primary_sidebar_end": [], + "github_url": "https://github.com/conda/conda-docs", "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", diff --git a/requirements.txt b/requirements.txt index 0d024cb14..a9e72ea71 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ --e git+https://github.com/conda-incubator/conda-sphinx-theme.git@main#egg=conda_sphinx_theme +conda-sphinx-theme sphinx-sitemap==2.2.0 sphinx-design sphinx-reredirects From 24d42f990c49af2d13af889ed73d8516cbe7490a Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Mon, 20 Nov 2023 16:53:33 +0100 Subject: [PATCH 15/15] updating landing page --- docs/source/index.rst | 110 +++++++++++++----------------------------- 1 file changed, 33 insertions(+), 77 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index bd9f85b32..7e01d0716 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,83 +6,6 @@ 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 :octicon:`download;1em;sd-text-primary` -================================================ - -We recommend the following methods to install conda: - -.. tab-set:: - - .. tab-item:: Windows :fab:`windows` - - Miniconda installer for: - - .. grid:: 2 - - .. grid-item:: - - .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe - :color: primary - - Windows x86 64-bit :octicon:`download` - - .. tab-item:: MacOS :fab:`apple` - - Miniconda installer for: - - .. grid:: 2 - - .. grid-item:: - - .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.pkg - :color: primary - - MacOS x86 64-bit :octicon:`download` - - .. grid-item:: - - .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg - :color: primary - - MacOS M1 64-bit :octicon:`download` - - .. tab-item:: Linux :fab:`linux` - - Miniconda installer for: - - .. grid:: 2 - - .. grid-item:: - - .. button-link:: https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh - :color: primary - - Linux x86 64-bit :octicon:`download` - - .. tab-item:: Homebrew :fa:`beer-mug-empty` - - Run the following `Homebrew `_ command: - - .. code-block:: bash - - brew install miniconda - - .. tab-item:: Chocolatey :octicon:`terminal` :fab:`windows` - - Run the following `Chocolatey `_ command: - - .. code-block:: bash - - choco install miniconda3 - - -.. raw:: html - -

For more detailed instructions, see Miniconda's installation guide

- -Learn -===== - .. grid:: 1 2 2 2 .. grid-item:: @@ -127,6 +50,39 @@ Learn Take deep dives into advanced topics on the internal workings of conda +Projects +======== + +.. grid:: 1 2 2 2 + + .. grid-item:: + + .. card:: conda :octicon:`terminal;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda/en/stable/ + + Conda provides all essential commands for creating and using environments + + .. grid-item:: + + .. card:: conda build :octicon:`package;1em;sd-text-primary` + :link: https://docs.conda.io/projects/conda-build/en/stable/ + + Conda build provides many tools that can be used to build conda packages + + .. grid-item:: + + .. card:: Miniconda :octicon:`database;1em;sd-text-primary` + :link: https://docs.conda.io/projects/miniconda/en/latest/ + + Miniconda is a conda installer provided by Anaconda + + .. grid-item:: + + .. card:: conda lock :octicon:`lock;1em;sd-text-primary` + :link: https://conda.github.io/conda-lock/ + + Conda lock generates fully reproducible lock files for conda environments + .. toctree:: :hidden: