Skip to content

Commit cf07bd1

Browse files
committed
docs: replace sphinx panels with sphinx design (its successor)
This unblocks the sphinx < 5 version constraint from sphinx panels
1 parent 5e5b1af commit cf07bd1

File tree

5 files changed

+64
-41
lines changed

5 files changed

+64
-41
lines changed

docs/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@
2929
package_dir=PACKAGE_DIR,
3030
packages=ALL_PACKAGES,
3131
scripts=SCRIPTS,
32-
install_requires=["sphinx_rtd_theme", "sphinx_panels"],
32+
install_requires=["sphinx_rtd_theme", "sphinx_design"],
3333
)

docs/source/AdministratorGuide/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _administrator_guide:
2+
13
===================
24
Administrator Guide
35
===================

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
"sphinx.ext.graphviz",
105105
"recommonmark",
106106
"sphinx_rtd_theme",
107-
"sphinx_panels",
107+
"sphinx_design",
108108
]
109109

110110

docs/source/index.rst

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -34,43 +34,64 @@ An alternative description of the DIRAC system can be found in this `presentatio
3434
Documentation
3535
=============
3636

37-
.. panels::
38-
:card: shadow + text-center
39-
:img-top-cls: p-5
40-
41-
:img-top: _static/dirac_user.png
42-
.. link-button:: UserGuide/index
43-
:type: ref
44-
:text: User Guide
45-
:classes: btn-link stretched-link font-weight-bold
46-
47-
including client installation
48-
49-
---
50-
:img-top: _static/dirac_dev.png
51-
.. link-button:: DeveloperGuide/index
52-
:type: ref
53-
:text: Developer Guide
54-
:classes: btn-link stretched-link font-weight-bold
55-
56-
adding new functionality to DIRAC
57-
58-
---
59-
:img-top: _static/dirac_admin.png
60-
.. link-button:: AdministratorGuide/index
61-
:type: ref
62-
:text: Administrator Guide
63-
:classes: btn-link stretched-link font-weight-bold
64-
65-
services administration, server installation
66-
67-
---
68-
:img-top: _static/dirac_code.png
69-
.. link-button:: CodeDocumentation/index
70-
:type: ref
71-
:text: Code Documentation
72-
:classes: btn-link stretched-link font-weight-bold
73-
74-
code reference
37+
.. grid:: 2
38+
:padding: 3
39+
:gutter: 3
40+
41+
.. grid-item-card::
42+
:shadow: lg
43+
:text-align: center
44+
:link-type: ref
45+
:class-body: btn-link stretched-link font-weight-bold
46+
:class-img-top: p-5
47+
:img-top: _static/dirac_user.png
48+
:link: user-guide
49+
:link-alt: User Guide
50+
51+
User Guide
52+
53+
including client installation
54+
55+
.. grid-item-card::
56+
:shadow: lg
57+
:text-align: center
58+
:link-type: ref
59+
:class-body: btn-link stretched-link font-weight-bold
60+
:class-img-top: p-5
61+
:img-top: _static/dirac_dev.png
62+
:link: developer_guide
63+
:link-alt: Developer Guide
64+
65+
Developer Guide
66+
67+
adding new functionality to DIRAC
68+
69+
70+
.. grid-item-card::
71+
:shadow: lg
72+
:text-align: center
73+
:link-type: ref
74+
:class-body: btn-link stretched-link font-weight-bold
75+
:class-img-top: p-5
76+
:img-top: _static/dirac_admin.png
77+
:link: administrator_guide
78+
:link-alt: Administrator Guide
79+
80+
Administrator Guide
81+
82+
services administration, server installation
83+
84+
85+
.. grid-item-card::
86+
:shadow: lg
87+
:text-align: center
88+
:link-type: ref
89+
:class-body: btn-link stretched-link font-weight-bold
90+
:class-img-top: p-5
91+
:img-top: _static/dirac_code.png
92+
:link: code_documentation
93+
:link-alt: Code Reference
94+
95+
code reference
7596

7697
:ref:`genindex`

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ dependencies:
7575
# RTD Sphinx theme
7676
- sphinx_rtd_theme
7777
# Bootstrap and new elements fo Sphinx
78-
- sphinx-panels
78+
- sphinx-design
7979
# unused
8080
- funcsigs
8181
- jinja2

0 commit comments

Comments
 (0)