doc: update to rst

jorgepiloto · Jan 26, 2024 · 42fc67d · 42fc67d
1 parent 1fcf5ee
commit 42fc67d
Show file tree

Hide file tree

Showing 9 changed files with 225 additions and 254 deletions.
diff --git a/...urce/explanations/the_lamberts_problem.md → doc/source/examples/the_lamberts_problem.md b/...urce/explanations/the_lamberts_problem.md → doc/source/examples/the_lamberts_problem.md
diff --git a/doc/source/getting-started/how-to-install.rst b/doc/source/getting-started/how-to-install.rst
@@ -0,0 +1,30 @@
+How to install
+==============
+
+This page contains the guide for installing the ``lamberthub`` package. If you
+experience any kind of problem during one of the steps shown in the following
+lines, please open an new issue (or select similar ones) in the `issues
+board <https://github.com/jorgepiloto/lamberthub/issues>`_
+
+Installing from PyPI
+--------------------
+
+The installation process is similar to other python packages, meaning that you
+only need to run:
+
+.. code-block:: bash
+
+    python -m pip install lamberthub
+
+Previous command installs the latest stable version of the library. Once
+done, you can open the Python terminal and import the package and verify its
+version by running:
+
+.. code-block:: python
+
+    import lamberthub
+    print(f"lamberthub v{lamberthub.__version__}")
+
+.. code-block:: python
+
+    lamberthub v|version|
diff --git a/doc/source/getting-started/how_to_contribute.md b/doc/source/getting-started/how_to_contribute.md
diff --git a/doc/source/getting-started/how_to_install.md b/doc/source/getting-started/how_to_install.md
diff --git a/doc/source/getting-started/how_to_use.md b/doc/source/getting-started/how_to_use.md
diff --git a/doc/source/getting-started/index.rst b/doc/source/getting-started/index.rst
@@ -0,0 +1,17 @@
+Getting started
+###############
+
+.. grid:: 1
+
+    .. grid-item-card:: Installation :fa:`person-running`
+        :link: getting-started/index
+        :link-type: doc
+
+        Step by step guidelines on how to set up your environment to work with
+        lamberthub. Install the library and verify it works as expected.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 3
+
+   how-to-install
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -8,6 +8,22 @@ different algorithms for solving the Lambert's problem:
    :width: 350px
    :align: center
 
+.. grid:: 2
+
+    .. grid-item-card:: Getting started :fa:`person-running`
+        :link: getting-started/index
+        :link-type: doc
+
+        Step by step guidelines on how to set up your environment to work with
+        lamberthub. Install the library and verify it works as expected.
+
+    .. grid-item-card:: User guide :fa:`book-open-reader`
+        :link: user-guide/index
+        :link-type: doc
+
+        Learn about the capabilities, features, and key topics in lamberthub.
+        This guide provides useful background information and explanations.
+
 Since the formulation of the problem, many different solutions have been
 devised, being the latest ones in the form of computer routines. By collecting
 and implementing all of them under a common programming language, it is possible
@@ -21,8 +37,8 @@ their routines.
        :hidden:
        :maxdepth: 3
 
-       getting_started/index
-       user_guide/index
+       getting-started/index
+       user-guide/index
        {% if build_examples %}
        examples
        {% endif %}

diff --git a/doc/source/user-guide/index.rst b/doc/source/user-guide/index.rst
@@ -0,0 +1,17 @@
+User guide
+##########
+
+.. grid:: 1
+
+    .. grid-item-card:: Overview :fa:`person-running`
+        :link: getting-started/index
+        :link-type: doc
+
+        Step by step guidelines on how to use lamberthub.
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 3
+
+   overview