feat: landing page improvements

doc/source/_static/css/landing_page.css → doc/source/_static/css/projects_sidebar.css

@@ -2,13 +2,13 @@ html {
   overflow-y: scroll !important;
 }
 
-.landing-page-sidebar {
+.projects-page-sidebar {
   margin-top: 2rem;
   display: flex;
   flex-direction: column;
   padding: 0rem 2rem;
 }
-.landing-page-sidebar-section {
+.projects-page-sidebar-section {
   margin-bottom: 2rem;
   font-weight: 700;
   display: flex;
@@ -20,7 +20,7 @@ html {
   margin-top: 1rem;
 }
 
-.landing-page-sidebar-section span {
+.projects-page-sidebar-section span {
   font-size: 0.85rem;
 }
 
@@ -112,7 +112,7 @@ html {
     grid-template-columns: 1fr;
   }
 
-  .landing-page-sidebar {
+  .projects-page-sidebar {
     padding: 1rem;
   }
 

doc/source/_templates/landing_page_sidebar.html → doc/source/_templates/projects_sidebar.html

@@ -1,7 +1,7 @@
-<div class="landing-page-sidebar">
+<div class="projects-page-sidebar">
 
     <!-- Product families -->
-    <div class="landing-page-sidebar-section product-families">
+    <div class="projects-page-sidebar-section product-families">
         <span>Product families</span>
         <div id="selected-product-families-list"></div>
         <div id="product-families-list"></div>
@@ -11,7 +11,7 @@
     <hr>
 
     <!-- Tags -->
-    <div class="landing-page-sidebar-section product-tags">
+    <div class="projects-page-sidebar-section product-tags">
         <span>Tags</span>
         <div id="selected-product-tags-list"></div>
         <div id="product-tags-list"></div>
@@ -23,4 +23,4 @@
 <script>
 const PROJECTS_FILE = "{{ pathto('_static/projects.json', 1) }}";
 </script>
-<script src="{{ pathto('_static/js/landing_page.js', 1) }}"></script>
+<script src="{{ pathto('_static/js/projects_sidebar.js', 1) }}"></script>

doc/source/blog.rst

@@ -0,0 +1,2 @@
+Blog
+####

doc/source/conf.py

@@ -71,7 +71,7 @@
 html_favicon = ansys_favicon
 
 html_sidebars = {
-    "index": ["landing_page_sidebar.html"],
+    "projects": ["projects_sidebar.html"],
 }
 
 extensions = [
@@ -84,7 +84,7 @@
 # Static files
 templates_path = ["_templates"]
 html_static_path = ["_static"]
-html_css_files = ["css/landing_page.css"]
+html_css_files = ["css/projects_sidebar.css"]
 
 metadata = Path(__file__).parent.parent.parent / "projects.yaml"
 
@@ -159,6 +159,7 @@ def get_last_metapackage_release():
             "needs_datatables": True,
         },
     },
+    "default_mode": "light",
 }
 
 html_theme_options = {
@@ -168,6 +169,10 @@ def get_last_metapackage_release():
     "show_breadcrumbs": True,
     "collapse_navigation": True,
     "use_edit_page_button": True,
+    "navbar_end": [
+        "navbar-icon-links",
+        "version-switcher",
+    ],
     "icon_links": [
         {
             "name": "Support",
@@ -184,7 +189,6 @@ def get_last_metapackage_release():
         "json_url": f"https://{cname}/versions.json",
         "version_match": switcher_version,
     },
-    "check_switcher": False,
     "static_search": {
         "threshold": 0.5,
         "min_chars_for_search": 2,

doc/source/index.rst

@@ -1,48 +1,14 @@
-=======
 PyAnsys
-=======
+#######
 
-Welcome to the PyAnsys project. While this project originated as a single ``pyansys`` package,
-it is now a collection of many Python packages for using Ansys products through Python:
+Welcome to the PyAnsys project. While this project originated as a single
+``pyansys`` package, it is now a collection of many Python packages for using
+Ansys products through Python:
 
 .. toctree::
-   :hidden:
-   :maxdepth: 3
+    :hidden:
+    :maxdepth: 3
 
-   getting-started
-   user_guide
-   api
-   examples
-   tools/index
-
-.. jinja:: project_context
-
-    .. raw:: html
-
-        <div class="projects">
-            {% for project, metadata in projects['projects'].items() %}
-
-            {% set family = metadata.get('family', 'other') | lower | replace(' ', '-') %}
-            {% set tags = metadata.get('tags', 'other') | lower %}
-
-            <div
-                class="project-card sd-card sd-shadow-sm sd-card-hover"
-                data-family="{{ family }}"
-                data-tags="{{ tags }}"
-                onclick="window.location.href='{{ metadata['documentation']['base'] }}';"
-            >
-                <img class="project-thumbnail" src="{{ metadata['thumbnail'] }}" />
-                <div class="sd-card-body">
-                    <p class="sd-card-title sd-font-weight-bold"> {{ metadata['name'] }} </p>
-                    <p class="sd-card-body-text"> {{ metadata['description'] }} </p>
-                    <p class="sd-card-text">
-                        <span class="sd-sphinx-override sd-badge sd-bg-muted sd-text-primary">{{ family.capitalize() }}</span>
-                        {% for tag in metadata['tags'] %}
-                        <span class="sd-sphinx-override sd-badge sd-bg-muted sd-text-primary">{{ tag }}</span>
-                        {% endfor %}
-                        </p>
-                </div>
-            </div>
-
-            {% endfor %}
-        </div>
+    getting-started
+    projects
+    blog

doc/source/projects.rst

@@ -0,0 +1,34 @@
+Projects
+########
+
+.. jinja:: project_context
+
+    .. raw:: html
+
+        <div class="projects">
+            {% for project, metadata in projects['projects'].items() %}
+
+            {% set family = metadata.get('family', 'other') | lower | replace(' ', '-') %}
+            {% set tags = metadata.get('tags', 'other') | lower %}
+
+            <div
+                class="project-card sd-card sd-shadow-sm sd-card-hover"
+                data-family="{{ family }}"
+                data-tags="{{ tags }}"
+                onclick="window.location.href='{{ metadata['documentation']['base'] }}';"
+            >
+                <img class="project-thumbnail" src="{{ metadata['thumbnail'] }}" />
+                <div class="sd-card-body">
+                    <p class="sd-card-title sd-font-weight-bold"> {{ metadata['name'] }} </p>
+                    <p class="sd-card-body-text"> {{ metadata['description'] }} </p>
+                    <p class="sd-card-text">
+                        <span class="sd-sphinx-override sd-badge sd-bg-muted sd-text-primary">{{ family.capitalize() }}</span>
+                        {% for tag in metadata['tags'] %}
+                        <span class="sd-sphinx-override sd-badge sd-bg-muted sd-text-primary">{{ tag }}</span>
+                        {% endfor %}
+                        </p>
+                </div>
+            </div>
+
+            {% endfor %}
+        </div>