Merge pull request #584 from RocketPy-Team/doc/landing-page

DOC: change rocketpy landing page to standard code docs.

Author: phmbressan

CHANGELOG.md

@@ -47,6 +47,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - MNT: refactor u_dot parachute method [#596](https://github.com/RocketPy-Team/RocketPy/pull/596)
 - BLD: Change setup.py to pyproject.toml [#589](https://github.com/RocketPy-Team/RocketPy/pull/589)
 - DEP: delete deprecated rocketpy.tools.cached_property [#587](https://github.com/RocketPy-Team/RocketPy/pull/587)
+- DOC: Change rocketpy Landing Page to Standard Code docs [#584](https://github.com/RocketPy-Team/RocketPy/pull/584)
 - ENH: Flight simulation speed up [#581] (https://github.com/RocketPy-Team/RocketPy/pull/581) 
 - MNT: Modularize Rocket Draw [#580](https://github.com/RocketPy-Team/RocketPy/pull/580)
 - DOC: Improvements of Environment docstring phrasing [#565](https://github.com/RocketPy-Team/RocketPy/pull/565)

docs/conf.py

@@ -41,7 +41,6 @@
     "sphinx_design",
     "jupyter_sphinx",
     "nbsphinx",
-    "m2r2",
 ]
 
 # source_suffix = '.rst'
@@ -96,7 +95,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["static"]
-html_css_files = ["notebooks.css"]
+html_css_files = ["rocketpy.css"]
 html_favicon = "static/favicon.ico"
 html_theme_options = {
     "logo_link": "index",

docs/index.rst

@@ -1,10 +1,92 @@
-.. RocketPy documentation master file, created by
-   sphinx-quickstart on Wed Mar  4 06:03:53 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+######################
+RocketPy Documentation
+######################
+
+**Version**: |release|
+
+**Useful links**:
+`Installation <https://docs.rocketpy.org/en/latest/user/installation.html>`_ |
+`Source Repository <https://github.com/RocketPy-Team/RocketPy>`_ |
+`Issue Tracker <https://github.com/RocketPy-Team/RocketPy/issues>`_ |
+`Q&A Support <https://discord.gg/b6xYnNh>`_ |
+
+RocketPy is the next-generation trajectory simulation solution for High-Power Rocketry. The code is written as a Python library and allows for a complete 6 degrees of freedom simulation of a rocket's flight trajectory, including high-fidelity variable mass effects as well as descent under parachutes. Weather conditions, such as wind profiles, can be imported from sophisticated datasets, allowing for realistic scenarios. Furthermore, the implementation facilitates complex simulations, such as multi-stage rockets, design and trajectory optimization and dispersion analysis.
+
+.. grid:: 2
+
+    .. grid-item-card::
+       :img-top: ./static/landing_images/getting_started.svg
+
+       Getting started
+       ^^^^^^^^^^^^^^^
+
+       Simulating your first rocket? Check out the Beginner's Guide. It contains an
+       introduction to RocketPy main concepts and walks you through the process of
+       setting up a simulation.
+
+       +++
+
+       .. button-ref:: user/first_simulation
+          :expand:
+          :color: secondary
+          :click-parent:
+
+          To the beginner's guide
+
+    .. grid-item-card::
+       :img-top: ./static/landing_images/user_guide.svg
+       
+       User guide
+       ^^^^^^^^^^
+
+       The user guide provides in-depth information on
+       RocketPy functionalities with useful background information and explanation.
+
+       +++
+
+       .. button-ref:: user/index
+          :expand:
+          :color: secondary
+          :click-parent:
+
+          To the user guide
+
+    .. grid-item-card::
+       :img-top: ./static/landing_images/api.svg
+
+       API reference
+       ^^^^^^^^^^^^^
+
+       The reference guide contains a detailed description of RocketPy modules. Here it is described how the methods work and which parameters can be used. It assumes that you already have an understanding of key concepts.
+
+       +++
+
+       .. button-ref:: reference/index
+          :expand:
+          :color: secondary
+          :click-parent:
+
+          To the reference guide
+
+    .. grid-item-card::
+       :img-top: ./static/landing_images/contributor.svg
+
+       Contributor's guide
+       ^^^^^^^^^^^^^^^^^^^
+
+       Want to contribute to RocketPy source code? The contributing guidelines will guide you through the process of improving RocketPy.
+
+       +++
+
+       .. button-ref:: development/index
+          :expand:
+          :color: secondary
+          :click-parent:
+
+          To the contributor's guide
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 1
    :hidden:
 
    User Guide <user/index>
@@ -13,11 +95,3 @@
    Technical <technical/index>
    Flight Examples <examples/index>
 
-.. mdinclude:: ../README.md
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/requirements.in

@@ -1,9 +1,7 @@
 nbsphinx==0.9.4
 pydata-sphinx-theme==0.15.2
-m2r2==0.3.3.post2
 jupyter-sphinx==0.5.3
 sphinx_design==0.5.0
 ipykernel==6.29.4
 pandas==2.2.2
-lxml_html_clean==0.1.1
-docutils==0.20.1
+lxml_html_clean==0.1.1

docs/requirements.txt

@@ -40,8 +40,6 @@ defusedxml==0.7.1
     # via nbconvert
 docutils==0.20.1
     # via
-    #   -r docs/requirements.in
-    #   m2r2
     #   nbsphinx
     #   pydata-sphinx-theme
     #   sphinx
@@ -100,8 +98,6 @@ lxml==5.2.2
     #   nbconvert
 lxml-html-clean==0.1.1
     # via -r docs/requirements.in
-m2r2==0.3.3.post2
-    # via -r docs/requirements.in
 markupsafe==2.1.5
     # via
     #   jinja2
@@ -111,9 +107,7 @@ matplotlib-inline==0.1.7
     #   ipykernel
     #   ipython
 mistune==0.8.4
-    # via
-    #   m2r2
-    #   nbconvert
+    # via nbconvert
 nbclient==0.10.0
     # via nbconvert
 nbconvert==6.5.4