Skip to content

Autodoc style bis #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 11, 2019
Merged

Autodoc style bis #188

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2dc791e
tweaks to look and feel of autodoc
nicolaskruchten Nov 10, 2019
974c8a3
longer underlines to avoid warnings
emmanuelle Nov 11, 2019
f5504d9
template for figure
emmanuelle Nov 11, 2019
cd94080
toc
emmanuelle Nov 11, 2019
c31ef55
tweaks
nicolaskruchten Nov 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
template for figure
  • Loading branch information
@emmanuelle
emmanuelle committed Nov 11, 2019
commit f5504d97c36f66ab4c941120818d9c5f0727a03e
13 changes: 4 additions & 9 deletions apidoc/_templates/class_figure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,18 @@
.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}

{% block methods %}
.. automethod:: __init__
.. automethod:: show
.. automethod:: update_layout
.. automethod:: add_traces
{% endblock %}

Other methods
{{ underline }}==============

.. autosummary::
:toctree: generated/

plotly.graph_objects.{{ objname }}

.. autoclass:: {{ objname }}
:members:
:inherited-members:

.. raw:: html

<div class="clearer"></div>

5 changes: 3 additions & 2 deletions apidoc/graph_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ Figure

.. autosummary::
:toctree: generated/
:template: trace.rst
:template: class_figure.rst

Figure

Figure

Layout
------
Expand Down