Merge pull request #42 from BlueBrain/doc-cosmetics

Polish doc
BlueBrain · Sep 12, 2023 · 44a941a · 44a941a
2 parents de30368 + 11eba20
commit 44a941a
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git 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 <https://github.com/BlueBrain/BluePyEModel/tree/main/examples/emodel_pipeline_local_python/>`_ and its `README <https://github.com/BlueBrain/BluePyEModel/tree/main/examples/emodel_pipeline_local_python>`_.
 
 The pipeline is divided in 6 steps:
 

diff --git 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
diff --git 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