From 73185d3cb77b1468212a91cae536524039648026 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikolas=20F=C3=B6rster?= Date: Wed, 2 Feb 2022 08:24:25 +0100 Subject: [PATCH] fix html-docu build error --- Contributing.rst | 25 +++++++++++++------------ sphinx/transistordatabase.rst | 6 +++--- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/Contributing.rst b/Contributing.rst index e962fde..a921776 100644 --- a/Contributing.rst +++ b/Contributing.rst @@ -81,23 +81,24 @@ Sphinx documentation using docstrings * Find a rst and sphinx cheat sheet `here `__. .. code-block:: + def print_tdb(filters: Optional[List[str]] = None, collection_name: str = "local") -> List[str]: - """ - Print all transistorelements stored in the local database + """ + Print all transistorelements stored in the local database - :param filters: filters for searching the database, e.g. 'name' or 'type' - :type filters: List[str] - :param collection_name: Choose database name in local mongodb client. Default name is "collection" - :type collection_name: str + :param filters: filters for searching the database, e.g. 'name' or 'type' + :type filters: List[str] + :param collection_name: Choose database name in local mongodb client. Default name is "collection" + :type collection_name: str - :return: Return a list with all transistor objects fitting to the search-filter - :rtype: list + :return: Return a list with all transistor objects fitting to the search-filter + :rtype: list - :Example: + :Example: - >>> import transistordatabase as tdb - >>> tdb.print_TDB() - """ + >>> import transistordatabase as tdb + >>> tdb.print_tdb() + """ unittesting with pytest ----------------------- diff --git a/sphinx/transistordatabase.rst b/sphinx/transistordatabase.rst index 0ea4bbb..37d6fb5 100644 --- a/sphinx/transistordatabase.rst +++ b/sphinx/transistordatabase.rst @@ -3,7 +3,7 @@ Documentation The ``Transistor`` class ***************************** -.. currentmodule:: transistordatabase.databaseClasses +.. currentmodule:: transistordatabase.tdb_classes .. autoclass:: Transistor :members: @@ -16,5 +16,5 @@ The ``Transistor`` class General methods ************************** -.. automodule:: transistordatabase.databaseClasses - :members: csv2array,merge_curve,print_TDB,connect_TDB,connect_local_TDB,load,update_from_fileexchange,import_json,r_g_max_rapid_channel_turn_off, export_all_datasheets +.. automodule:: transistordatabase.tdb_functions + :members: csv2array,merge_curve,print_tdb,connect_tdb,connect_local_tdb,r_g_max_rapid_channel_turn_off