Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restructure sphinx doc #1978

Merged
merged 1 commit into from
Feb 7, 2023
Merged

Restructure sphinx doc #1978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions documentation/CPP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ C++ interface

.. toctree::
:maxdepth: 2
:caption: C++


Installation <cpp_installation>
Usage <cpp_interface>
Expand Down
1 change: 1 addition & 0 deletions documentation/MATLAB.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Matlab interface

.. toctree::
:maxdepth: 2
:caption: MATLAB

Installation <matlab_installation>
Usage <matlab_interface>
Expand Down
2 changes: 2 additions & 0 deletions documentation/PYTHON.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ Python interface

.. toctree::
:maxdepth: 2
:caption: Python

Installation <python_installation>
Examples <python_examples>
Usage <python_interface>
FAQ <python_faq>
API reference <python_modules>
10 changes: 3 additions & 7 deletions documentation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,9 @@ Welcome to AMICI's documentation!
glossary
contributing

.. toctree::
:maxdepth: 2
:caption: User's guide

PYTHON
CPP
MATLAB
.. include:: PYTHON.rst
.. include:: CPP.rst
.. include:: MATLAB.rst

.. toctree::
:maxdepth: 2
Expand Down
18 changes: 18 additions & 0 deletions documentation/python_examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Examples
========

Various example notebooks.

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/AMICI-dev/AMICI/develop?labpath=binder%2Foverview.ipynb

.. toctree::
:maxdepth: 1

GettingStarted.ipynb
ExampleSteadystate.ipynb
petab.ipynb
ExampleExperimentalConditions.ipynb
ExampleEquilibrationLogic.ipynb
example_errors.ipynb
example_large_models/example_performance_optimization.ipynb
17 changes: 0 additions & 17 deletions documentation/python_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,23 +134,6 @@ SED-ML import
We also plan to implement support for the
`Simulation Experiment Description Markup Language (SED-ML) <https://sed-ml.org/>`_.

Examples
========

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/AMICI-dev/AMICI/develop?labpath=binder%2Foverview.ipynb

.. toctree::
:maxdepth: 1

GettingStarted.ipynb
ExampleSteadystate.ipynb
petab.ipynb
ExampleExperimentalConditions.ipynb
ExampleEquilibrationLogic.ipynb
example_errors.ipynb
example_large_models/example_performance_optimization.ipynb

Environment variables affecting model import
============================================

Expand Down