Skip to content
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.

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

Add summaries to API docs #1304

Merged
merged 1 commit into from
May 5, 2017
Merged

Add summaries to API docs #1304

merged 1 commit into from
May 5, 2017

Conversation

tbekolay
Copy link
Member

@tbekolay tbekolay commented Apr 20, 2017

Motivation and context:
@celiasmith pointed out that the API docs pages are long and hard to navigate. This PR adds summaries to frontend_api and networks to (hopefully) make them easier to navigate.

When built, networks looks like this:

netsummary

And frontend_api looks like this:

api

That's only the amount that would fit on the screen, it goes on for a while more.

How has this been tested?
Built the docs to see how it renders.

How long should this take to review?

  • Quick (less than 40 lines changed or changes are straightforward)

Types of changes:

  • Non-code change (touches things like tests, documentation, build scripts)

Checklist:

  • I have read the CONTRIBUTING.rst document.
  • I have updated the documentation accordingly.
  • I have included a changelog entry.
  • [na] I have added tests to cover my changes.
  • All new and existing tests passed.

Still to do:

One thing we should discuss is whether the frontend_api summary should contain all things that are listed on that page, or if we should omit things that users aren't likely to interact with very much, like base classes and LearningRule, Thoughts?

@jgosmann
Copy link
Collaborator

Is it possible to exclude all the distributions from that table and have a separate table only for distributions?

@tbekolay
Copy link
Member Author

Is it possible to exclude all the distributions from that table and have a separate table only for distributions?

Yep, all is possible. I can split it up so there's a summary per heading too, that might make sense (since the headings are shown in the left sidebar and are clickable to get to subgroups easily).

@jgosmann
Copy link
Collaborator

Yep, all is possible.

That would be great!

@tbekolay
Copy link
Member Author

Pushed a fixup separating the frontend_api summaries into separate sections; here's the distributions section (the others look similar):

dists

This seems like an improvement to me 👍

@tbekolay tbekolay merged commit d9d7fee into master May 5, 2017
@tbekolay tbekolay deleted the add-summaries branch May 5, 2017 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants