diff --git a/README.rst b/README.rst index d8d8df62..c87cc289 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,7 @@ To get started with the E-Model building pipeline .. image:: https://raw.githubusercontent.com/BlueBrain/BluePyEModel/main/doc/images/pipeline.png :alt: E-Model building pipeline -This section presents a general picture of the pipeline. For a detailed picture and how to use it, please refer to the example directory `./examples/emodel_pipeline_local_python <./examples/emodel_pipeline_local_python>`_ and its `README <./examples/emodel_pipeline_local_python/README.rst>`_. +This section presents a general picture of the pipeline. For a detailed picture and how to use it, please refer to the `example directory `_ and its `README `_. The pipeline is divided in 6 steps: diff --git a/doc/source/api_ref.rst b/doc/source/api_ref.rst index d106f911..3dd5faa9 100644 --- a/doc/source/api_ref.rst +++ b/doc/source/api_ref.rst @@ -1,10 +1,25 @@ -API Reference -============= +BluePyEModel +============ -This page contains auto-generated API reference documentation. +.. automodule:: bluepyemodel + :members: + :show-inheritance: + + +.. rubric:: Modules .. autosummary:: :toctree: _autosummary :recursive: - bluepyemodel + access_point + ecode + efeatures_extraction + emodel_pipeline + evaluation + export_emodel + model + optimisation + tasks + tools + validation \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index a21e9be0..166310d8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,6 +20,7 @@ # -- Project information ----------------------------------------------------- project = "BluePyEModel" +author = 'Blue Brain Project/EPFL' # The short X.Y version version = get_distribution("bluepyemodel").version