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.

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

Polish doc #42

Merged
merged 3 commits into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
23 changes: 19 additions & 4 deletions doc/source/api_ref.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
# -- Project information -----------------------------------------------------

project = "BluePyEModel"
author = 'Blue Brain Project/EPFL'

# The short X.Y version
version = get_distribution("bluepyemodel").version
Expand Down