Skip to content

Commit 6775531

Browse files
committed
Reorganize documentation TOC
1 parent 01b7eb7 commit 6775531

6 files changed

+22
-12
lines changed

docs/source/advanced-features.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Advanced Features and API Reference
2-
===================================
2+
====================================
33

44
This guide covers advanced features of the Rxn-INSIGHT package and
55
provides a concise API reference for the core classes.

docs/source/common-use-cases.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Rxn-INSIGHT: Common Use Cases
1+
Potential Use Cases
22
=============================
33

44
This guide demonstrates how Rxn-INSIGHT can be applied to solve specific

docs/source/getting-started.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Getting Started with Rxn-INSIGHT
2-
================================
1+
Getting Started
2+
===============
33

44
This quick-start guide will get you up and running with Rxn-INSIGHT in
55
just a few minutes. We will cover installation, basic usage, and a simple

docs/source/index.rst

+14-4
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,24 @@ Please cite the Rxn-INSIGHT `paper <https://doi.org/10.1186/s13321-024-00834-z>`
2323

2424
.. toctree::
2525
:maxdepth: 2
26-
:caption: Contents
26+
:caption: Quickstart
2727

28-
rxn_insight
28+
installation
2929
getting-started
30-
common-use-cases
3130
advanced-features
31+
32+
.. toctree::
33+
:maxdepth: 2
34+
:caption: Guides
35+
36+
common-use-cases
3237
visualization-guide
33-
installation
38+
39+
.. toctree::
40+
:maxdepth: 2
41+
:caption: API Documentation
42+
43+
rxn_insight
3444

3545

3646
Indices and tables

docs/source/rxn_insight.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Rxn-INSIGHT
2-
====================
1+
rxn_insight
2+
============
33

44
Submodules
55
----------

docs/source/visualization-guide.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Visualizing Chemical Reactions with Rxn-INSIGHT
2-
===============================================
1+
Visualizing Chemical Reactions
2+
==============================
33

44
This tutorial demonstrates how to create effective visualizations of
55
reactions, their components, and analysis results using Rxn-INSIGHT

0 commit comments

Comments
 (0)