Skip to content

Commit

Permalink
deploy: 7dfc44b
Browse files Browse the repository at this point in the history
  • Loading branch information
@wesselb
wesselb committed Sep 21, 2023
1 parent 165501a commit 74eb4ad
Show file tree
Hide file tree
Showing 34 changed files with 633 additions and 7 deletions.
1 change: 1 addition & 0 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/alias.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/autoreload.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/dispatcher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/function.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/parametric.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/promotion.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/resolver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/signature.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/type.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/plum/util.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Application Programming Interface</a></li>
Expand Down
42 changes: 42 additions & 0 deletions _sources/command_line.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Command Line Configuration Options

## `PLUM_SIMPLE_DOC`

Set `PLUM_SIMPLE_DOC=1` to prevent Plum from concatenating the docstrings of all methods.
Consider

```python
from plum import dispatch


@dispatch.abstract
def do(x):
"""Do something."""


@dispatch
def do(x: int) -> int:
"""Do something with integers."""
```

The usual output of `help(f)` is as follows:
```
Help on Function in module __main__:
do(x)
Do something.
---------------------------
do(x: int) -> int
Do something with integers.
```

With `PLUM_SIMPLE_DOC=1`, `help(f)` only shows the docstring of the first registered method:
```
Help on Function in module __main__:
do(x)
Do something.
```
1 change: 1 addition & 0 deletions advanced_usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
<li class="toctree-l2"><a class="reference internal" href="parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Application Programming Interface</a></li>
Expand Down
7 changes: 4 additions & 3 deletions api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'api';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Support for IPython Autoreload" href="autoreload.html" />
<link rel="prev" title="Command Line Configuration Options" href="command_line.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -182,6 +182,7 @@
<li class="toctree-l2"><a class="reference internal" href="parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Application Programming Interface</a></li>
Expand Down Expand Up @@ -1341,12 +1342,12 @@ <h1>Application Programming Interface<a class="headerlink" href="#application-pr
<!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="autoreload.html"
href="command_line.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Support for IPython Autoreload</p>
<p class="prev-next-title">Command Line Configuration Options</p>
</div>
</a>
</div>
Expand Down
7 changes: 4 additions & 3 deletions autoreload.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'autoreload';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Application Programming Interface" href="api.html" />
<link rel="next" title="Command Line Configuration Options" href="command_line.html" />
<link rel="prev" title="Union Aliases" href="union_aliases.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -183,6 +183,7 @@
<li class="toctree-l2"><a class="reference internal" href="parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Application Programming Interface</a></li>
Expand Down Expand Up @@ -448,11 +449,11 @@ <h1>Support for IPython Autoreload<a class="headerlink" href="#support-for-ipyth
</div>
</a>
<a class="right-next"
href="api.html"
href="command_line.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Application Programming Interface</p>
<p class="prev-next-title">Command Line Configuration Options</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
1 change: 1 addition & 0 deletions basic_usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
<li class="toctree-l2"><a class="reference internal" href="parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Application Programming Interface</a></li>
Expand Down
1 change: 1 addition & 0 deletions classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
<li class="toctree-l2"><a class="reference internal" href="parametric.html">Parametric Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="union_aliases.html">Union Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="autoreload.html">Support for IPython Autoreload</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_line.html">Command Line Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Application Programming Interface</a></li>
Expand Down
Loading

0 comments on commit 74eb4ad

Please sign in to comment.