Skip to content

Commit 226e334

Browse files
Revathyvenugopal162pre-commit-ci[bot]RobPasMue
authored
docs: update sphinx card design options for documentation (#784)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
1 parent d567d42 commit 226e334

File tree

4 files changed

+88
-115
lines changed

4 files changed

+88
-115
lines changed

doc/source/_static/custom.css

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
11
@import "../ansys-sphinx-theme.css";
22

3-
.col-md-3 {
4-
flex: 0 0 30%;
5-
max-width: 30%;
6-
}
7-
.col-xl-7 {
8-
flex: 0 0 53.33333%;
9-
max-width: 53.33333%;
10-
}
11-
12-
.bd-toc {
13-
padding-top: 5em;
14-
}
15-
16-
/* Remove once implemented in ansys-sphinx-theme*/
173

184
.sd-card .sd-card-img-top {
195
height: 100px;
@@ -23,20 +9,11 @@
239
}
2410

2511
.sd-card .sd-card-header {
26-
border: none;
27-
background-color:white;
28-
color: #150458 !important;
2912
font-size: var(--pst-font-size-h5);
3013
font-weight: bold;
31-
padding: .5rem 0rem 0.5rem 0rem;
32-
text-align: center;
14+
padding: 1rem 0rem 0.5rem 0rem;
3315
}
3416

3517
.sd-card .sd-card-footer .sd-card-text {
3618
max-width: 220px;
37-
margin-left: auto;
38-
margin-right: auto;
39-
}
40-
.sd-card .sd-card-text {
41-
text-align: center;
4219
}

doc/source/getting_started/docker/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ meaning that certain operations are not available or fail.
2727
Select the kind of Docker container you want to build:
2828

2929
.. grid:: 2
30+
:gutter: 3 3 4 4
3031

3132
.. grid-item-card:: Windows Docker container
3233
:link: windows_container
3334
:link-type: doc
34-
:margin: 2 2 0 0
3535

3636
Build a Windows Docker container for the Geometry service
3737
and use it from PyAnsys Geometry. Explore the full potential
@@ -40,7 +40,6 @@ Select the kind of Docker container you want to build:
4040
.. grid-item-card:: Linux Docker container
4141
:link: linux_container
4242
:link-type: doc
43-
:margin: 2 2 0 0
4443

4544
Test out the Linux Docker container for the Geometry service,
4645
which has limited functionalities.

doc/source/getting_started/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,32 @@ running this backend, although the preferred and high-performance mode is using
1313
containers. Select the option that suits your needs best.
1414

1515
.. grid:: 2
16+
:gutter: 3 3 4 4
1617

1718
.. grid-item-card:: Docker containers
1819
:link: docker/index
1920
:link-type: doc
20-
:margin: 2 2 0 0
2121

2222
Launch the Geometry service as a Docker container
2323
and connect to it from PyAnsys Geometry.
2424

2525
.. grid-item-card:: Local service
2626
:link: local/index
2727
:link-type: doc
28-
:margin: 2 2 0 0
2928

3029
Launch the Geometry service locally on your machine
3130
and connect to it from PyAnsys Geometry.
3231

3332
.. grid-item-card:: Remote service
3433
:link: remote/index
3534
:link-type: doc
36-
:margin: 2 2 0 0
3735

3836
Launch the Geometry service on a remote machine and
3937
connect to it using PIM (Product Instance Manager).
4038

4139
.. grid-item-card:: Connect to an existing service
4240
:link: existing/index
4341
:link-type: doc
44-
:margin: 2 2 0 0
4542

4643
Connect to an existing Geometry service locally or remotely.
4744

doc/source/index.rst

Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -3,126 +3,126 @@ PyAnsys Geometry documentation |version|
33

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

6-
.. grid:: 2
6+
.. grid:: 1 2 2 2
7+
:gutter: 4
8+
:padding: 2 2 0 0
9+
:class-container: sd-text-center
710

8-
.. grid-item-card::
9-
:img-top: _static/assets/index_getting_started.png
11+
.. grid-item-card:: Getting started
12+
:img-top: _static/assets/index_getting_started.png
13+
:class-card: intro-card
1014

11-
Getting started
12-
^^^^^^^^^^^^^^^
15+
Learn how to run the Windows Docker container, install the
16+
PyAnsys Geometry image, and launch and connect to the Geometry
17+
service.
1318

14-
Learn how to run the Windows Docker container, install the
15-
PyAnsys Geometry image, and launch and connect to the Geometry
16-
service.
19+
+++
20+
.. button-link:: getting_started/index.html
21+
:color: secondary
22+
:outline:
23+
:expand:
24+
:click-parent:
1725

18-
+++
26+
Getting started
1927

20-
.. button-link:: getting_started/index.html
21-
:color: secondary
22-
:expand:
23-
:outline:
24-
:click-parent:
28+
.. grid-item-card:: User guide
29+
:img-top: _static/assets/index_user_guide.png
30+
:class-card: intro-card
2531

26-
Getting started
32+
Understand key concepts and approaches for primitives,
33+
sketches, and model designs.
2734

28-
.. grid-item-card::
29-
:img-top: _static/assets/index_user_guide.png
35+
+++
36+
.. button-link:: user_guide/index.html
37+
:color: secondary
38+
:expand:
39+
:outline:
40+
:click-parent:
3041

31-
User guide
32-
^^^^^^^^^^
42+
User guide
3343

34-
Understand key concepts and approaches for primitives,
35-
sketches, and model designs.
36-
37-
+++
38-
.. button-link:: user_guide/index.html
39-
:color: secondary
40-
:expand:
41-
:outline:
42-
:click-parent:
43-
44-
User guide
4544

4645

4746
.. jinja:: main_toctree
4847

49-
.. grid:: 2
48+
.. grid:: 1 2 2 2
49+
:gutter: 4
50+
:padding: 2 2 0 0
51+
:class-container: sd-text-center
5052

5153
{% if build_api %}
52-
.. grid-item-card::
53-
:img-top: _static/assets/index_api.png
54-
55-
API reference
56-
^^^^^^^^^^^^^
54+
.. grid-item-card:: API reference
55+
:img-top: _static/assets/index_api.png
56+
:class-card: intro-card
5757

58-
Understand PyAnsys Geometry API endpoints, their capabilities,
59-
and how to interact with them programmatically.
58+
Understand PyAnsys Geometry API endpoints, their capabilities,
59+
and how to interact with them programmatically.
6060

61-
+++
62-
.. button-link:: api/index.html
63-
:color: secondary
64-
:expand:
65-
:outline:
66-
:click-parent:
61+
+++
62+
.. button-link:: api/index.html
63+
:color: secondary
64+
:expand:
65+
:outline:
66+
:click-parent:
6767

68-
API reference
68+
API reference
6969
{% endif %}
7070

7171
{% if build_examples %}
72-
.. grid-item-card::
73-
:img-top: _static/assets/index_examples.png
72+
.. grid-item-card:: Examples
73+
:img-top: _static/assets/index_examples.png
74+
:class-card: intro-card
7475

75-
Examples
76-
^^^^^^^^
76+
Explore examples that show how to use PyAnsys Geometry to
77+
perform many different types of operations.
7778

78-
Explore examples that show how to use PyAnsys Geometry to
79-
perform many different types of operations.
79+
+++
80+
.. button-link:: examples.html
81+
:color: secondary
82+
:expand:
83+
:outline:
84+
:click-parent:
8085

81-
+++
82-
.. button-link:: examples.html
83-
:color: secondary
84-
:expand:
85-
:outline:
86-
:click-parent:
86+
Examples
8787

88-
Examples
8988
{% endif %}
9089

91-
.. grid:: 2
90+
.. grid:: 1 2 2 2
91+
:gutter: 4
92+
:padding: 2 2 0 0
93+
:class-container: sd-text-center
9294

93-
.. grid-item-card::
94-
:img-top: _static/assets/index_contribute.png
95+
.. grid-item-card:: Contribute
96+
:img-top: _static/assets/index_contribute.png
97+
:class-card: intro-card
9598

96-
Contribute
97-
^^^^^^^^^^
98-
Learn how to contribute to the PyAnsys Geometry codebase
99-
or documentation.
99+
Learn how to contribute to the PyAnsys Geometry codebase
100+
or documentation.
100101

101-
+++
102-
.. button-link:: contributing.html
103-
:color: secondary
104-
:expand:
105-
:outline:
106-
:click-parent:
102+
+++
103+
.. button-link:: contributing.html
104+
:color: secondary
105+
:expand:
106+
:outline:
107+
:click-parent:
107108

108-
Contribute
109+
Contribute
109110

110-
.. grid-item-card::
111-
:img-top: _static/assets/index_download.png
111+
.. grid-item-card:: Assets
112+
:img-top: _static/assets/index_download.png
113+
:class-card: intro-card
112114

113-
Assets
114-
^^^^^^
115-
Download different assets related to PyAnsys Geometry,
116-
such as documentation, package wheelhouse, and related files.
115+
Download different assets related to PyAnsys Geometry,
116+
such as documentation, package wheelhouse, and related files.
117117

118-
+++
119-
.. button-link:: assets.html
120-
:color: secondary
121-
:expand:
122-
:outline:
123-
:click-parent:
118+
+++
119+
.. button-link:: assets.html
120+
:color: secondary
121+
:expand:
122+
:outline:
123+
:click-parent:
124124

125-
Assets
125+
Assets
126126

127127
.. jinja:: main_toctree
128128

0 commit comments

Comments
 (0)