Skip to content

Commit 15ebedb

Browse files
committed
clean up docs
1 parent b8b890b commit 15ebedb

2 files changed

Lines changed: 17 additions & 20 deletions

File tree

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
html_static_path = ['_static', 'logos']
4646
html_css_files = ['custom.css']
4747
html_logo = 'logos/pathsim_logo.png'
48+
html_title = "PathSim-Chem Documentation"
4849

4950
html_theme_options = {
5051
"light_css_variables": {
@@ -59,7 +60,7 @@
5960
"color-api-keyword": "#377eb8",
6061
"color-highlight-on-target": "#fff3cd",
6162
},
62-
"sidebar_hide_name": False,
63+
"sidebar_hide_name": True,
6364
"navigation_with_keys": True,
6465
"top_of_page_button": "edit",
6566
"source_repository": "https://github.com/pathsim/pathsim-chem",

docs/source/index.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,28 @@ PathSim-Chem provides specialized blocks for chemical engineering simulations,
77
extending the core `PathSim <https://pathsim.readthedocs.io>`_ framework with
88
domain-specific functionality.
99

10+
.. raw:: html
11+
12+
<div style="text-align: center; margin: 2rem 0;">
13+
<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);">
14+
PathSim
15+
</a>
16+
<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);">
17+
View on GitHub
18+
</a>
19+
<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);">
20+
Issue Tracker
21+
</a>
22+
</div>
23+
1024
Installation
1125
------------
1226

1327
.. code-block:: bash
1428
1529
pip install pathsim-chem
1630
17-
Quick Start
18-
-----------
19-
20-
.. code-block:: python
21-
22-
import pathsim as ps
23-
import pathsim_chem as psc
24-
25-
# Your chemical engineering simulations here
26-
2731
.. toctree::
28-
:maxdepth: 2
29-
:caption: Contents
32+
:hidden:
3033

3134
api
32-
33-
Links
34-
-----
35-
36-
* `Core PathSim Documentation <https://pathsim.readthedocs.io>`_
37-
* `GitHub Repository <https://github.com/pathsim/pathsim-chem>`_
38-
* `Issue Tracker <https://github.com/pathsim/pathsim-chem/issues>`_

0 commit comments

Comments
 (0)