Skip to content

Commit

Permalink
update documentation formating
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinPdeS committed Dec 19, 2024
1 parent cbada23 commit 8da341b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/source/code/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Source Code Structures
=======================
API Reference
=============

This section provides an overview of the classes and components available in the PyMieSim package. Each component listed below inherits relevant attributes and methods, allowing users to build flexible and customizable scattering simulations.
This overview serves as a guide for understanding how the package is organized and how its parts can be used to simulate different optical scattering scenarios.
Expand Down
30 changes: 20 additions & 10 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def setup(app):
]

autodoc_typehints = "description"
autosummary_generate = True

# Napoleon settings for docstrings
napoleon_google_docstring = False
Expand Down Expand Up @@ -88,10 +89,11 @@ def reset_mpl(gallery_conf, fname):


autodoc_default_options = {
'members': False,
"members": True,
"undoc-members": False,
"show-inheritance": True,
"exclude-members": "__annotations__",
'members-order': 'bysource',
'undoc-members': False,
'show-inheritance': True,
}

autosectionlabel_prefix_document = True
Expand All @@ -109,24 +111,29 @@ def reset_mpl(gallery_conf, fname):

exclude_trees = []
# default_role = "autolink"
show_authors = True
pygments_style = "sphinx"

# -- Sphinx-gallery configuration --------------------------------------------
major, minor = version[:2]
binder_branch = f"v{major}.{minor}.x"

html_context = {
"github_url": "https://github.com", # or your GitHub Enterprise site
"github_user": package_name,
"github_repo": package_name,
"github_version": "master",
"doc_path": "doc/source",
"default_mode": "dark",
}

html_theme_options = dict()

html_theme_options['logo'] = dict(text=package_name, image="_static/thumbnail.png")
html_theme_options["show_nav_level"] = 0

html_theme_options.update({
"icon_links": [
{
"name": "GitHub",
"url": f"https://github.com/MartinPdeS/{package_name}",
"icon": "fa-brands fa-github",
},
{
"name": "PyPI",
"url": f"https://pypi.org/project/{package_name}/",
Expand All @@ -139,7 +146,7 @@ def reset_mpl(gallery_conf, fname):
},
],
"navbar_align": "left",
"navbar_end": ["version-switcher", "navbar-icon-links"],
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
"show_prev_next": False,
"show_version_warning_banner": True,
# Footer
Expand Down Expand Up @@ -186,4 +193,7 @@ def reset_mpl(gallery_conf, fname):
html_css_files = ['default.css']
epub_exclude_files = ['search.html']

# -
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
'numpy': ('https://numpy.org/devdocs', None),
}

0 comments on commit 8da341b

Please sign in to comment.