From 3ecdd61b988a1d98dfecfa9ca5e7e700ddf8c1c4 Mon Sep 17 00:00:00 2001 From: Federico Negri Date: Wed, 6 Mar 2024 09:42:48 +0100 Subject: [PATCH 1/2] add grid --- doc/source/conf.py | 1 + doc/source/index.rst | 52 +++++++++++++++++++++++++++++++++----------- 2 files changed, 40 insertions(+), 13 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index acbae1741..6b1f53781 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -38,6 +38,7 @@ "sphinx_design", "sphinx_tabs.tabs", "sphinxcontrib.autodoc_pydantic", + "sphinx_jinja", ] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] diff --git a/doc/source/index.rst b/doc/source/index.rst index a35e77aae..59770914b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,6 @@ PyHPS documentation |version| ============================= -.. toctree:: - :hidden: - :maxdepth: 3 - - getting_started/index - user_guide/index - examples/index - api/index - contribute - -Introduction ------------- - Ansys HPC Platform Services (HPS) is a set of technology components designed to help you manage the execution of simulations while making use of your full range of computing assets. @@ -23,3 +10,42 @@ PyHPS brings HPS to your Python app. Wrapping around HPS REST APIs, PyHPS allows * Monitor and manage jobs. * Run your own design exploration algorithms. * Retrieve simulation results. + + +.. grid:: 1 1 2 2 + :gutter: 2 + + .. grid-item-card:: :octicon:`rocket` Getting started + :link: getting_started/index + :link-type: doc + + Contains installation instructions to get you + started with PyHPS. + + .. grid-item-card:: :octicon:`tools` User guide + :link: user_guide/index + :link-type: doc + + Walks you through the basics of how to interact with HPS. + + .. grid-item-card:: :octicon:`play` Examples + :link: examples/index + :link-type: doc + + A collection of examples demonstrating how to submit jobs using PyHPS. + + .. grid-item-card:: :octicon:`file-code` API reference + :link: api/index + :link-type: doc + + Describes the public Python classes, methods, and functions. + +.. toctree:: + :hidden: + :maxdepth: 3 + + getting_started/index + user_guide/index + examples/index + api/index + contribute \ No newline at end of file From 6863a8d25e207cbff2be2a75d996ca3dab16bf6d Mon Sep 17 00:00:00 2001 From: Federico Negri Date: Wed, 6 Mar 2024 18:30:59 +0100 Subject: [PATCH 2/2] incorporate kathy's suggestions --- doc/source/index.rst | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 59770914b..5e9660153 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,30 +15,37 @@ PyHPS brings HPS to your Python app. Wrapping around HPS REST APIs, PyHPS allows .. grid:: 1 1 2 2 :gutter: 2 - .. grid-item-card:: :octicon:`rocket` Getting started + .. grid-item-card:: Getting started :fa:`person-running` :link: getting_started/index :link-type: doc - Contains installation instructions to get you - started with PyHPS. + Learn how to install and start using PyHPS. - .. grid-item-card:: :octicon:`tools` User guide + .. grid-item-card:: User guide :fa:`book-open-reader` :link: user_guide/index :link-type: doc - Walks you through the basics of how to interact with HPS. + Understand the basics of how to interact with HPS. - .. grid-item-card:: :octicon:`play` Examples + .. grid-item-card:: API reference :fa:`book-bookmark` + :link: api/index + :link-type: doc + + Understand the PyHPS API, its capabilities, + and how to interact with it programmatically. + + .. grid-item-card:: Examples :fa:`scroll` :link: examples/index :link-type: doc - A collection of examples demonstrating how to submit jobs using PyHPS. + Explore examples that show how to use PyHPS to submit jobs. - .. grid-item-card:: :octicon:`file-code` API reference - :link: api/index + .. grid-item-card:: Contribute :fa:`people-group` + :link: contribute :link-type: doc - Describes the public Python classes, methods, and functions. + Learn how to contribute to the PyHPS codebase + or documentation. .. toctree:: :hidden: @@ -46,6 +53,6 @@ PyHPS brings HPS to your Python app. Wrapping around HPS REST APIs, PyHPS allows getting_started/index user_guide/index - examples/index api/index + examples/index contribute \ No newline at end of file