Skip to content

tweaks to look and feel of autodoc #186

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

tweaks to look and feel of autodoc #186

wants to merge 1 commit into from

Conversation

nicolaskruchten
Copy link
Contributor

Here's a quick pass of suggested changes to the autodoc layout.

@emmanuelle
Copy link
Contributor

My only concern is that the methods of go.Figure have disappeared.

@nicolaskruchten
Copy link
Contributor Author

Oh that's weird... when I was rendering this last night it wasn't doing this.

@nicolaskruchten
Copy link
Contributor Author

I think there was some make caching happening such that things looked great after make html but not after make clean :(

nicolaskruchten
nicolaskruchten commented Nov 11, 2019
View reviewed changes
apidoc/graph_objects.rst
figure.rst
.. autosummary::
:toctree: generated/
:template: trace.rst
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emmanuelle is this the line that's preventing the Figure methods from appearing? should we have a Figure-specific template that makes them appear so we can keep the rest of this formatting in place?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm working on it, can I push a commit directly to your branch? We need the template to include the members and inherited-members (which was done in the figure.rst file).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, and yes, feel free to push to this branch!

@emmanuelle emmanuelle mentioned this pull request Nov 11, 2019
Merged
@emmanuelle
Copy link
Contributor

I just spent 2 hours trying all possible options with autoclass and autosummary... I pushed to #188 an alternative solution which exposes methods of Figure, and has everything in generated (but we lose the toc with update_layout etc., it seems that I can't get all of this to work together :-()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emmanuelle emmanuelle Awaiting requested review from emmanuelle

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nicolaskruchten @emmanuelle