Skip to content

Commit 72310e9

Browse files
committed
DOC: rework main doc page layout
1 parent 1ec2cf9 commit 72310e9

File tree

2 files changed

+28
-86
lines changed

2 files changed

+28
-86
lines changed

doc/source/_static/custom.css

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,14 @@
2828
color: #150458 !important;
2929
font-size: var(--pst-font-size-h5);
3030
font-weight: bold;
31-
padding: .5rem 0rem 0.5rem 0rem;
32-
text-align: center;
31+
padding: .1rem 0rem 0.5rem 0rem;
3332
}
3433

3534
.sd-card .sd-card-footer .sd-card-text {
3635
max-width: 220px;
3736
margin-left: auto;
3837
margin-right: auto;
3938
}
40-
.sd-card .sd-card-text {
41-
text-align: center;
42-
}
4339

4440
nav.bd-links ul li.toctree-l1 > a {
4541
font-size: .90rem;

doc/source/index.rst

Lines changed: 27 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -6,96 +6,42 @@ API to make scripting simpler.
66

77
.. grid:: 2
88

9-
.. grid-item-card::
10-
:img-top: _static/assets/index_getting_started.png
9+
.. grid-item-card:: Getting started :fa:`person-running`
10+
:padding: 2 2 2 2
11+
:link: getting_started/index
12+
:link-type: doc
1113

12-
Getting started
13-
^^^^^^^^^^^^^^^
14+
Learn more about PyEDB and how to install and use it. Also view
15+
important version, interface, and troubleshooting information.
1416

15-
Learn more about PyEDB and how to install and use it. Also view
16-
important version, interface, and troubleshooting information.
17+
.. grid-item-card:: User guide :fa:`book-open-reader`
18+
:padding: 2 2 2 2
19+
:link: user_guide/index
20+
:link-type: doc
1721

18-
+++
22+
Understand how to use PyEDB by looking at some simple tutorials.
1923

20-
.. button-link:: getting_started/index.html
21-
:color: secondary
22-
:expand:
23-
:outline:
24-
:click-parent:
24+
.. grid-item-card:: API reference :fa:`book-bookmark`
25+
:padding: 2 2 2 2
26+
:link: api/index
27+
:link-type: doc
2528

26-
Getting started
29+
Understand PyEDB API endpoints, their capabilities,
30+
and how to interact with them programmatically.
2731

28-
.. grid-item-card::
29-
:img-top: _static/assets/index_user_guide.png
32+
.. grid-item-card:: Examples :fa:`scroll`
33+
:padding: 2 2 2 2
34+
:link: examples
35+
:link-type: doc
3036

31-
User guide
32-
^^^^^^^^^^
37+
Explore examples that show how to use PyEDB to
38+
perform many different types of simulations.
3339

34-
Understand how to use PyEDB by looking at some simple tutorials.
3540

36-
+++
37-
.. button-link:: user_guide/index.html
38-
:color: secondary
39-
:expand:
40-
:outline:
41-
:click-parent:
42-
43-
User guide
44-
45-
46-
47-
.. grid-item-card::
48-
:img-top: _static/assets/index_api.png
49-
50-
API reference
51-
^^^^^^^^^^^^^
52-
53-
Understand PyEDB API endpoints, their capabilities,
54-
and how to interact with them programmatically.
55-
56-
+++
57-
.. button-link:: api/index.html
58-
:color: secondary
59-
:expand:
60-
:outline:
61-
:click-parent:
62-
63-
EDB API reference
64-
65-
.. grid-item-card::
66-
:img-top: _static/assets/index_examples.png
67-
68-
Examples
69-
^^^^^^^^
70-
71-
Explore examples that show how to use PyEDB to
72-
perform different types of simulations.
73-
74-
+++
75-
.. button-link:: examples/index.html
76-
:color: secondary
77-
:expand:
78-
:outline:
79-
:click-parent:
80-
81-
Examples
82-
83-
.. grid-item-card::
84-
:img-top: _static/assets/index_contribute.png
85-
86-
Contribute
87-
^^^^^^^^^^
88-
Learn how to contribute to the PyEDB codebase
89-
or documentation.
90-
91-
+++
92-
.. button-link:: getting_started/Contributing.html
93-
:color: secondary
94-
:expand:
95-
:outline:
96-
:click-parent:
97-
98-
Contribute
41+
.. grid-item-card:: Contribute :fa:`people-group`
42+
:padding: 2 2 2 2
43+
:link: getting_started/contributing
44+
:link-type: doc
9945

10046
.. toctree::
10147
:hidden:

0 commit comments

Comments
 (0)