diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css new file mode 100644 index 000000000..04091a98a --- /dev/null +++ b/docs/source/_static/style.css @@ -0,0 +1,49 @@ +@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap'); + +body { + font-family: 'Open Sans', sans-serif; +} + +h1 { + font-family: "Lato", sans-serif; +} + +pre, +code { + font-size: 100%; + line-height: 155%; +} + +/* Main page overview cards */ + +.sd-card { + border-radius: 0; + padding: 30px 10px 20px 10px; + margin: 10px 0px; +} + +.sd-card .sd-card-header { + text-align: center; +} + +.sd-card .sd-card-title { + text-align: center; +} + +.sd-card .sd-card-header .sd-card-text { + margin: 0px; +} + +.sd-card .sd-card-img-top { + height: 52px; + width: 52px; + margin-left: auto; + margin-right: auto; +} + +.sd-card .sd-card-header { + border: none; + font-size: var(--pst-font-size-h5); + font-weight: bold; + padding: 2.5rem 0rem 0.5rem 0rem; +} \ No newline at end of file diff --git a/docs/source/images/icons/book-2-svgrepo-com.svg b/docs/source/images/icons/book-2-svgrepo-com.svg new file mode 100644 index 000000000..b24aa3976 --- /dev/null +++ b/docs/source/images/icons/book-2-svgrepo-com.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/check-square-svgrepo-com.svg b/docs/source/images/icons/check-square-svgrepo-com.svg new file mode 100644 index 000000000..fbdfb91c6 --- /dev/null +++ b/docs/source/images/icons/check-square-svgrepo-com.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/clapperboard-play-svgrepo-com.svg b/docs/source/images/icons/clapperboard-play-svgrepo-com.svg new file mode 100644 index 000000000..3d68ad02d --- /dev/null +++ b/docs/source/images/icons/clapperboard-play-svgrepo-com.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/code-square-svgrepo-com.svg b/docs/source/images/icons/code-square-svgrepo-com.svg new file mode 100644 index 000000000..142d36bf7 --- /dev/null +++ b/docs/source/images/icons/code-square-svgrepo-com.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/keyboard-svgrepo-com.svg b/docs/source/images/icons/keyboard-svgrepo-com.svg new file mode 100644 index 000000000..027f70f42 --- /dev/null +++ b/docs/source/images/icons/keyboard-svgrepo-com.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/running-2-svgrepo-com.svg b/docs/source/images/icons/running-2-svgrepo-com.svg new file mode 100644 index 000000000..f0699589a --- /dev/null +++ b/docs/source/images/icons/running-2-svgrepo-com.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 423e5240a..2ca1c9324 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,6 +11,49 @@ The tool is based on the finite element methods to solve the McNabb & Foster tra It is capable of solving 1D/2D/3D multimaterial simulations and provides support for a wide-range of boundary conditions, which makes it a very versatile tool that can be adapted to many use cases. Moreover, users can rapidly get started with FESTIM thanks to its python API. +.. All the logos are from this collection https://www.svgrepo.com/collection/solar-linear-icons/ + +.. grid:: 3 + :gutter: 2 + + .. grid-item:: + + .. card:: Installation + :img-top: images/icons/running-2-svgrepo-com.svg + :link: installation + :link-type: doc + + .. grid-item:: + + .. card:: User guide + :img-top: images/icons/book-2-svgrepo-com.svg + :link: userguide/index + :link-type: doc + + .. grid-item:: + + .. card:: Tutorials + :img-top: images/icons/clapperboard-play-svgrepo-com.svg + :link: https://github.com/festim-dev/FESTIM-workshop + + .. grid-item:: + + .. card:: Developer guide + :img-top: images/icons/code-square-svgrepo-com.svg + :link: devguide/index + :link-type: doc + + .. grid-item:: + .. card:: V&V + :img-top: images/icons/check-square-svgrepo-com.svg + :link: https://festim-vv-report.readthedocs.io/en/latest/ + + .. grid-item:: + .. card:: API reference + :img-top: images/icons/keyboard-svgrepo-com.svg + :link: api/festim + :link-type: doc + FESTIM was originally developed at the `Institute for Magnetic Fusion Research (IRFM) `_ and the `Process and Materials Sciences Laboratory (LSPM) `_. Various research institutions and private companies now contribute actively to FESTIM's development. For more information, feel free to ask questions on the `FESTIM Discourse Page `_.