Skip to content

Commit

Permalink
Add imperative interface documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
frthjf committed Dec 6, 2023
1 parent a9e820d commit 14ac836
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 14 deletions.
8 changes: 2 additions & 6 deletions docs/guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@ Guide/Examples

.. toctree::
:maxdepth: 2
:caption: Guide
:caption: Examples

Indices and tables
==================
../tutorial/MiV-Simulator-Cases/3-interface-api/rc-separation

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 1 addition & 1 deletion docs/tutorial/MiV-Simulator-Cases
2 changes: 1 addition & 1 deletion docs/tutorial/docker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation: Docker Image
# Docker Image

:::{note}
The docker image is not optimized for high-performance computing. The image file only provides necessary installation for users to quickly try-run a simple model.
Expand Down
6 changes: 1 addition & 5 deletions docs/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,13 @@ Tutorial

.. toctree::
:maxdepth: 2
:caption: How-To
:caption: Installation

installation
docker

.. include:: MiV-Simulator-Cases/toctree.rstlib

.. toctree::
:maxdepth: 2
:caption: Case Study


Indices and tables
==================
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation: Generic from Source
# From Source

The installation consist two part: python-dependencies and external libraries.

Expand Down

0 comments on commit 14ac836

Please sign in to comment.