diff --git a/docs/conf.py b/docs/conf.py index 2394ebe..d17af83 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,7 +73,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/docs/index.rst b/docs/index.rst index 63bab0a..7ec3371 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,12 @@ -=============================================================== -EBRAINS/HBP Validation Framework - Python Client: Documentation -=============================================================== +=========================================================== +EBRAINS Validation Framework - Python Client: Documentation +=========================================================== .. toctree:: :maxdepth: 2 -.. automodule:: ebrains_validation_framework + reference + Quick Overview ============== @@ -154,7 +155,7 @@ General Info Regarding EBRAINS Authentication -============================ +================================ The Python Client for the Validation Framework attempts to simplify the EBRAINS authentication process. It does this as follows: @@ -176,17 +177,8 @@ requests that require authentication. This approach has been found to significan speed-up the processing of the requests. If the authentication token expires, or is found to be invalid, then the user would again be given the above two options. -TestLibrary -=========== -.. autoclass:: TestLibrary - :members: -ModelCatalog -============ -.. autoclass:: ModelCatalog - :members: +Reference +========= -Utilities -============ -.. automodule:: ebrains_validation_framework.utils - :members: +See :doc:`reference`. diff --git a/docs/reference.rst b/docs/reference.rst new file mode 100644 index 0000000..fd3293e --- /dev/null +++ b/docs/reference.rst @@ -0,0 +1,22 @@ +======================= +Reference documentation +======================= + +.. automodule:: ebrains_validation_framework + + + +TestLibrary +=========== +.. autoclass:: TestLibrary + :members: + +ModelCatalog +============ +.. autoclass:: ModelCatalog + :members: + +Utilities +========= +.. automodule:: ebrains_validation_framework.utils + :members: