Skip to content

Commit

Permalink
Remove module name from object names in the documentation. (#285)
Browse files Browse the repository at this point in the history
* Remove module name from object names in the documentation.

* Update conf.py
  • Loading branch information
waltsims authored Feb 1, 2024
1 parent f43790d commit 20890d2
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'k-wave-python'
project = 'k-Wave-python'
copyright = '2022, Walter Simson, Farid Yagubbayli'
author = 'Walter Simson, Farid Yagubbayli'
version = '0.1.0'
version = '0.3.1'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down Expand Up @@ -55,3 +55,6 @@

# Don't show class signature with the class' name.
autodoc_class_signature = "separated"

# Remove module name from object names
add_module_names = False

0 comments on commit 20890d2

Please sign in to comment.