Skip to content

Commit

Permalink
docs: replace sphinx panels with sphinx design (its successor)
Browse files Browse the repository at this point in the history
This unblocks the sphinx < 5 version constraint from sphinx panels
  • Loading branch information
andresailer committed Jul 31, 2023
1 parent 5e5b1af commit cf96381
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 41 deletions.
2 changes: 1 addition & 1 deletion docs/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@
package_dir=PACKAGE_DIR,
packages=ALL_PACKAGES,
scripts=SCRIPTS,
install_requires=["sphinx_rtd_theme", "sphinx_panels"],
install_requires=["sphinx_rtd_theme", "sphinx_design"],
)
2 changes: 2 additions & 0 deletions docs/source/AdministratorGuide/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _administrator_guide:

===================
Administrator Guide
===================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
"sphinx.ext.graphviz",
"recommonmark",
"sphinx_rtd_theme",
"sphinx_panels",
"sphinx_design",
]


Expand Down
97 changes: 59 additions & 38 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,43 +34,64 @@ An alternative description of the DIRAC system can be found in this `presentatio
Documentation
=============

.. panels::
:card: shadow + text-center
:img-top-cls: p-5

:img-top: _static/dirac_user.png
.. link-button:: UserGuide/index
:type: ref
:text: User Guide
:classes: btn-link stretched-link font-weight-bold

including client installation

---
:img-top: _static/dirac_dev.png
.. link-button:: DeveloperGuide/index
:type: ref
:text: Developer Guide
:classes: btn-link stretched-link font-weight-bold

adding new functionality to DIRAC

---
:img-top: _static/dirac_admin.png
.. link-button:: AdministratorGuide/index
:type: ref
:text: Administrator Guide
:classes: btn-link stretched-link font-weight-bold

services administration, server installation

---
:img-top: _static/dirac_code.png
.. link-button:: CodeDocumentation/index
:type: ref
:text: Code Documentation
:classes: btn-link stretched-link font-weight-bold

code reference
.. grid:: 2
:padding: 3
:gutter: 3

.. grid-item-card::
:shadow: lg
:text-align: center
:link-type: ref
:class-body: btn-link stretched-link font-weight-bold
:class-img-top: p-5
:img-top: _static/dirac_user.png
:link: user-guide
:link-alt: User Guide

User Guide

including client installation

.. grid-item-card::
:shadow: lg
:text-align: center
:link-type: ref
:class-body: btn-link stretched-link font-weight-bold
:class-img-top: p-5
:img-top: _static/dirac_dev.png
:link: developer_guide
:link-alt: Developer Guide

Developer Guide

adding new functionality to DIRAC


.. grid-item-card::
:shadow: lg
:text-align: center
:link-type: ref
:class-body: btn-link stretched-link font-weight-bold
:class-img-top: p-5
:img-top: _static/dirac_admin.png
:link: administrator_guide
:link-alt: Administrator Guide

Administrator Guide

services administration, server installation


.. grid-item-card::
:shadow: lg
:text-align: center
:link-type: ref
:class-body: btn-link stretched-link font-weight-bold
:class-img-top: p-5
:img-top: _static/dirac_code.png
:link: code_documentation
:link-alt: Code Reference

code reference

:ref:`genindex`
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ dependencies:
# RTD Sphinx theme
- sphinx_rtd_theme
# Bootstrap and new elements fo Sphinx
- sphinx-panels
- sphinx_design
# unused
- funcsigs
- jinja2
Expand Down

0 comments on commit cf96381

Please sign in to comment.