Skip to content

Commit

Permalink
Updates to autodoc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
JWock82 committed Nov 10, 2023
1 parent 4254bba commit 89c83b2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/FEModel3D.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ Avaliable dictionaries are:
FEModel3D Reference
===================

.. autoclass:: FEModel3D
.. autoclass:: PyNite.FEModel3D
:members:
8 changes: 3 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@
import sys
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('../../PyNite'))
sys.path.insert(0, os.path.abspath('../../PyNite/FEModel3D'))

# autodoc settings
autodoc_mock_imports = ['numpy'] # Mock the numpy import
from PyNite import FEModel3D

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
Expand All @@ -30,6 +25,9 @@

extensions = ['sphinx.ext.autodoc']

# Control how class names are displayed
autoclass_content = 'class'

templates_path = ['_templates']
exclude_patterns = []

Expand Down

0 comments on commit 89c83b2

Please sign in to comment.