diff --git a/.github/labels.yml b/.github/labels.yml index ebd68b8089..0a5c4e3592 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -100,4 +100,12 @@ - name: remote-session description: Issues related to remote sessions in PyMechanical - color: 00B3B3 \ No newline at end of file + color: 00B3B3 + +- name: skip-doc + description: Skips the documentation build job in CI + color: e4e669 + +- name: skip-test + description: Skips the test job in CI + color: e4e669 \ No newline at end of file diff --git a/doc/changelog.d/1587.fixed.md b/doc/changelog.d/1587.fixed.md new file mode 100644 index 0000000000..5e516cc00e --- /dev/null +++ b/doc/changelog.d/1587.fixed.md @@ -0,0 +1 @@ +Update button in landing page diff --git a/doc/source/index.rst b/doc/source/index.rst index 19a7ab500d..c7011c8b03 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -26,8 +26,8 @@ Choose the one that fits your workflow: :padding: 2 2 2 2 :link: user_guide/embedding/overview :link-type: doc - :class-card: sd-border-warning - :class-title: sd-font-weight-bold sd-text-warning sd-fs-5 + :class-card: sd-border-info + :class-title: sd-font-weight-bold sd-text-info sd-fs-5 Run Mechanical **directly in your Python process** with the ``App`` class. Provides full object-model access, fast startup, and is ideal for Jupyter notebooks @@ -41,14 +41,14 @@ Choose the one that fits your workflow: Model.AddStaticStructuralAnalysis() - :bdg-warning:`In-process` :bdg-warning:`Direct API` :bdg-warning:`fast` + :bdg-info:`In-process` :bdg-info:`Direct API` :bdg-info:`fast` .. grid-item-card:: Remote session mode :fa:`server` :padding: 2 2 2 2 :link: user_guide/remote_session/overview :link-type: doc - :class-card: sd-border-warning - :class-title: sd-font-weight-bold sd-text-warning sd-fs-5 + :class-card: sd-border-info + :class-title: sd-font-weight-bold sd-text-info sd-fs-5 Launch Mechanical as a **separate server process** and communicate with gRPC. Provides process isolation, and optional GUI, and is ideal for CI/CD, Docker and automation. @@ -61,7 +61,7 @@ Choose the one that fits your workflow: app.run_python_script("Model.AddStaticStructuralAnalysis()") - :bdg-warning:`gRPC` :bdg-warning:`GUI` :bdg-warning:`Remote` + :bdg-info:`gRPC` :bdg-info:`GUI` :bdg-info:`Remote` If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mode`. @@ -77,16 +77,16 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo Install PyMechanical, choose your mode, and run your first script. - :bdg-warning-line:`Install` :bdg-warning-line:`Choose mode` :bdg-warning-line:`Quick start` + :bdg-info:`Install` :bdg-info:`Choose mode` :bdg-info:`Quick start` - .. grid-item-card:: User Guide :fa:`window-maximize` + .. grid-item-card:: User guide :fa:`window-maximize` :padding: 2 2 2 2 :link: user_guide/index :link-type: doc Learn how to use embedding mode, remote sessions, scripting, and CLI tools. - :bdg-warning-line:`Embedding` :bdg-warning-line:`Remote` :bdg-warning-line:`Scripting` + :bdg-info:`Embedding` :bdg-info:`Remote` :bdg-info:`Scripting` .. grid-item-card:: Examples :fa:`scroll` :padding: 2 2 2 2 @@ -95,7 +95,7 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo Explore examples, which are organized by mode and simulation type. - :bdg-warning-line:`Embedding` :bdg-warning-line:`Remote` :bdg-warning-line:`Advanced` + :bdg-info:`Embedding` :bdg-info:`Remote` :bdg-info:`Advanced` .. grid-item-card:: API reference :fa:`book-bookmark` :padding: 2 2 2 2 @@ -104,7 +104,7 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo Understand PyMechanical API endpoints and their capabilities. - :bdg-warning-line:`Classes` :bdg-warning-line:`Methods` :bdg-warning-line:`Error handling` + :bdg-info:`Classes` :bdg-info:`Methods` :bdg-info:`Error handling` .. grid-item-card:: FAQs :fa:`fa-solid fa-circle-question` @@ -114,7 +114,7 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo Frequently asked questions and their answers. - :bdg-warning-line:`How` :bdg-warning-line:`Why` :bdg-warning-line:`What` + :bdg-info:`How` :bdg-info:`Why` :bdg-info:`What` .. grid-item-card:: Known issues and limitations :fa:`fa-solid fa-bug` :padding: 2 2 2 2 @@ -123,7 +123,7 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo See issues and limitations for both PyMechanical and Mechanical. - :bdg-warning-line:`24R2` :bdg-warning-line:`25R1` :bdg-warning-line:`25R2` :bdg-warning-line:`26R1` + :bdg-info:`24R2` :bdg-info:`25R1` :bdg-info:`25R2` :bdg-info:`26R1` .. grid-item-card:: Contribute :fa:`people-group` :padding: 2 2 2 2 @@ -133,7 +133,7 @@ If you are not sure which mode to pick, see :doc:`getting_started/choose_your_mo Learn how to contribute to the PyMechanical codebase or documentation. - :bdg-warning-line:`Test` :bdg-warning-line:`Documentation` :bdg-warning-line:`Issues` + :bdg-info:`Test` :bdg-info:`Documentation` :bdg-info:`Issues` .. toctree:: diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index ce6845c1c6..7cceef0110 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -9,9 +9,9 @@ fundamentals and CLI tools. - **Embedding mode**: Use Mechanical directly in your Python process with the ``App`` class. - **Remote session mode**: Launch Mechanical as a server and communicate with gRPC. -- **Scripting fundamentals**: Explore Mechanical API concepts, recording, and threading, which +- **Scripting fundamentals (both modes)**: Explore Mechanical API concepts, recording, and threading, which are all topics applying to both modes. -- **CLI tools**: Discover command-line utilities for launching, discovering, and configuring Mechanical. +- **Command Line Interface (CLI)**: Discover command-line utilities for launching, discovering, and configuring Mechanical. If you are not sure which mode to use, see :ref:`ref_choose_your_mode`.