Skip to content

Commit

Permalink
feat: readapt landing page (#953)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
RobPasMue and pre-commit-ci[bot] committed Jan 23, 2024
1 parent 801a0f3 commit 4386a2b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 44 deletions.
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ def get_wheelhouse_assets_dictionary():
# change the preamble of latex with customized title page
# variables are the title of pdf, watermark
latex_elements = {"preamble": latex.generate_preamble(html_title)}
sd_fontawesome_latex = True

linkcheck_exclude_documents = ["index", "getting_started/local/index", "assets"]
linkcheck_ignore = [r"https://github.com/ansys/pyansys-geometry-binaries/.*"]
Expand Down
82 changes: 38 additions & 44 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,63 +3,57 @@ PyAnsys Geometry documentation |version|

PyAnsys Geometry is a Python client library for the Ansys Geometry service.

.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid:: 2

.. grid-item-card:: :material-regular:`directions_run` Getting started

Learn how to run the Windows Docker container, install the
PyAnsys Geometry image, and launch and connect to the Geometry
service.
.. grid-item-card:: Getting started :fa:`person-running`
:padding: 2 2 2 2
:link: getting_started/index
:link-type: doc

.. grid-item-card:: :material-regular:`book` User guide
Learn how to run the Windows Docker container, install the
PyAnsys Geometry image, and launch and connect to the Geometry
service.

Understand key concepts and approaches for primitives,
sketches, and model designs.
.. grid-item-card:: User guide :fa:`book-open-reader`
:padding: 2 2 2 2
:link: user_guide/index
:link-type: doc

Understand key concepts and approaches for primitives,
sketches, and model designs.

.. jinja:: main_toctree

.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center

{% if build_api %}
.. grid-item-card:: :material-regular:`code` API reference


Understand PyAnsys Geometry API endpoints, their capabilities,
and how to interact with them programmatically.
.. grid-item-card:: API reference :fa:`book-bookmark`
:padding: 2 2 2 2
:link: api/index
:link-type: doc

{% endif %}

{% if build_examples %}
.. grid-item-card:: :material-regular:`terminal` Examples
:class-card: intro-card

Explore examples that show how to use PyAnsys Geometry to
perform many different types of operations.

{% endif %}
Understand PyAnsys Geometry API endpoints, their capabilities,
and how to interact with them programmatically.

.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid-item-card:: Examples :fa:`scroll`
:padding: 2 2 2 2
:link: examples
:link-type: doc

.. grid-item-card:: :material-regular:`diversity_3` Contribute
Explore examples that show how to use PyAnsys Geometry to
perform many different types of operations.

Learn how to contribute to the PyAnsys Geometry codebase
or documentation.
.. grid-item-card:: Contribute :fa:`people-group`
:padding: 2 2 2 2
:link: contributing
:link-type: doc

.. grid-item-card:: :material-regular:`download` Assets
Learn how to contribute to the PyAnsys Geometry codebase
or documentation.

Download different assets related to PyAnsys Geometry,
such as documentation, package wheelhouse, and related files.
.. grid-item-card:: Download :fa:`download`
:padding: 2 2 2 2
:link: assets
:link-type: doc

Download different assets related to PyAnsys Geometry,
such as documentation, package wheelhouse, and related files.

.. jinja:: main_toctree

Expand Down

0 comments on commit 4386a2b

Please sign in to comment.