Merge pull request #5 from pathsim/initial-setup

clean up docs

Author: milanofthe

docs/source/conf.py

@@ -45,6 +45,7 @@
 html_static_path = ['_static', 'logos']
 html_css_files = ['custom.css']
 html_logo = 'logos/pathsim_logo.png'
+html_title = "PathSim-Chem Documentation"
 
 html_theme_options = {
     "light_css_variables": {
@@ -59,7 +60,7 @@
         "color-api-keyword": "#377eb8",
         "color-highlight-on-target": "#fff3cd",
     },
-    "sidebar_hide_name": False,
+    "sidebar_hide_name": True,
     "navigation_with_keys": True,
     "top_of_page_button": "edit",
     "source_repository": "https://github.com/pathsim/pathsim-chem",

docs/source/index.rst

@@ -7,32 +7,28 @@ PathSim-Chem provides specialized blocks for chemical engineering simulations,
 extending the core `PathSim <https://pathsim.readthedocs.io>`_ framework with
 domain-specific functionality.
 
+.. raw:: html
+
+   <div style="text-align: center; margin: 2rem 0;">
+      <a href="https://pathsim.readthedocs.io" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
+         PathSim
+      </a>
+      <a href="https://github.com/pathsim/pathsim-chem" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
+         View on GitHub
+      </a>
+      <a href="https://github.com/pathsim/pathsim-chem/issues" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
+         Issue Tracker
+      </a>
+   </div>
+
 Installation
 ------------
 
 .. code-block:: bash
 
    pip install pathsim-chem
 
-Quick Start
------------
-
-.. code-block:: python
-
-   import pathsim as ps
-   import pathsim_chem as psc
-
-   # Your chemical engineering simulations here
-
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents
+   :hidden:
 
    api
-
-Links
------
-
-* `Core PathSim Documentation <https://pathsim.readthedocs.io>`_
-* `GitHub Repository <https://github.com/pathsim/pathsim-chem>`_
-* `Issue Tracker <https://github.com/pathsim/pathsim-chem/issues>`_