Skip to content

Commit

Permalink
fix html-docu build error
Browse files Browse the repository at this point in the history
  • Loading branch information
gituser789 committed Feb 2, 2022
1 parent 98f122d commit 73185d3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
25 changes: 13 additions & 12 deletions Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,23 +81,24 @@ Sphinx documentation using docstrings
* Find a rst and sphinx cheat sheet `here <https://sphinx-tutorial.readthedocs.io/cheatsheet/>`__.

.. 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
-----------------------
Expand Down
6 changes: 3 additions & 3 deletions sphinx/transistordatabase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Documentation
The ``Transistor`` class
*****************************

.. currentmodule:: transistordatabase.databaseClasses
.. currentmodule:: transistordatabase.tdb_classes

.. autoclass:: Transistor
:members:
Expand All @@ -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

0 comments on commit 73185d3

Please sign in to comment.