Skip to content

Commit

Permalink
doc: use grid and cards in main index
Browse files Browse the repository at this point in the history
Signed-off-by: Etienne Millon <[email protected]>
  • Loading branch information
emillon committed Jan 17, 2024
1 parent a928672 commit b59dabb
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
extensions = [
'sphinx_copybutton',
'sphinx_dunedomain',
'sphinx_design',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
43 changes: 41 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,47 @@
Welcome to Dune's Documentation!
================================
Dune Documentation
==================

.. grid:: 1 1 1 2
:gutter: 2

.. grid-item-card:: :doc:`getting-started/index`

**Start here**: a presentation of Dune and how to use it

.. grid-item-card:: :doc:`howto/index`

**Step-by-step guides** to help you succeed with Dune

.. grid-item-card:: :doc:`reference/index`

**Reference information** about stanzas, actions, DSLs, and commands

.. grid-item-card:: :doc:`explanation/index`

**Explanation** of how certain aspects of Dune work

.. grid-item-card:: :doc:`advanced/index`

**Advanced topics**

.. grid-item-card:: :doc:`misc/index`

**Miscellaneous info** about Dune

Quick Links
-----------

Not your first time here? You might be looking for these pages:

.. grid:: 1 1 1 4

.. grid-item-card:: :doc:`Stanzas <dune-files>`
.. grid-item-card:: :doc:`Actions <reference/actions>`
.. grid-item-card:: :doc:`concepts/variables`

.. toctree::
:maxdepth: 2
:hidden:

getting-started/index
howto/index
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx >= 4.5.0, < 6
sphinx_rtd_theme >= 1.0.0
sphinx-copybutton >= 0.5.0
sphinx-design
1 change: 1 addition & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@
sphinx-autobuild
python310Packages.sphinx-copybutton
python310Packages.sphinx-rtd-theme
python310Packages.sphinx-design
]
);
meta.description = ''
Expand Down

0 comments on commit b59dabb

Please sign in to comment.