Skip to content

Commit

Permalink
Fix and reorganize API docs (#7659)
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr authored Jan 23, 2025
1 parent f7c4462 commit 9f703f3
Show file tree
Hide file tree
Showing 63 changed files with 554 additions and 755 deletions.
72 changes: 64 additions & 8 deletions doc/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,28 +32,73 @@ The `panel.state` object holds session state and provide various methods to atta

::::


-------

## Module Structure

[`panel.auth`](panel.auth)
: Module containing authentication handlers.

[`panel.chat`](panel.chat)
: Subpackage containing Panel Chat components

[`panel.command`](panel.chat)
: Subpackage containing Panel CLI commands

[`panel.compiler`](panel.compiler)
: Utilities for bundling and compiling external JS and CSS resources.

[`panel.config`](panel.config)
: Module containing Panel config and extension objects.

[`panel.custom`](panel.custom)
: Baseclasses for creating custom components.

[`panel.depends`](panel.depends)
: Module exposing `param.bind` and `param.depends`.

[`panel.interact`](panel.interact)
: Module implementing the `interact` API.

[`panel.io`](panel.io)
: Utilities for working with Panel components
: Subpackage containing all IO related functionality.

[`panel.layout`](panel.layout)
: Panel layout components
: Subpackage containing layout components

[`panel.links`](panel.links)
: Module containing implementation responsible Javascript linking and callbacks.

[`panel.models`](panel.models)
: Subpackage containing Bokeh model implementations of custom components.

[`panel.pane`](panel.pane)
: Panel layout components
: Subpackage containing `Pane` components.

[`panel.param`](panel.param)
: Components for integration with the param library
: Module implementing components for integration with the param library.

[`panel.pipeline`](panel.pipeline)
: Panel Pipeline component
: Module containing the `Pipeline` component.

[`panel.widgets`](panel.widgets)
: Widget components
[`panel.reactive`](panel.reactive)
: Module containing baseclasses for Panel components with reactive APIs.

[`panel.template`](panel.template)
: Subpackage containing implementations for `Template` components.

[`panel.theme`](panel.theme)
: Subpackage implementing `Design` and `Theme` components.

[`panel.util`](panel.util)
: Subpackage containing generic utilities.

[`panel.viewable`](panel.viewable)
: Baseclasses for all Panel components
: Module containing baseclasses for all Panel components.

[`panel.widgets`](panel.widgets)
: Subpackage containing `Widget` components.

```{toctree}
:titlesonly:
Expand All @@ -63,12 +108,23 @@ The `panel.state` object holds session state and provide various methods to atta
cheatsheet
config
state
panel.auth
panel.chat
panel.command
panel.compiler
panel.config
panel.custom
panel.depends
panel.io
panel.layout
panel.links
panel.models
panel.pane
panel.param
panel.pipeline
panel.reactive
panel.template
panel.theme
panel.util
panel.viewable
panel.widgets
Expand Down
4 changes: 4 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@


extensions = [
'numpydoc',
'bokeh.sphinxext.bokeh_plot',
'myst_parser',
'sphinx_design',
Expand All @@ -103,6 +104,9 @@
'nbsite.pyodide',
'nbsite.analytics',
]

numpydoc_show_inherited_class_members = False
numpydoc_class_members_toctree = False
napoleon_numpy_docstring = True

autodoc_mock_imports = ["panel.pane.vtk"]
Expand Down
272 changes: 0 additions & 272 deletions doc/generate_modules.py

This file was deleted.

Loading

0 comments on commit 9f703f3

Please sign in to comment.