Skip to content

DOC: tweak template to use automodule (not currentmodule) - #9386

Merged
QuLogic merged 1 commit into
matplotlib:v2.1.0-docfrom
tacaswell:doc_fix_inventory
Oct 13, 2017
Merged

DOC: tweak template to use automodule (not currentmodule)#9386
QuLogic merged 1 commit into
matplotlib:v2.1.0-docfrom
tacaswell:doc_fix_inventory

Conversation

@tacaswell

@tacaswell tacaswell commented Oct 13, 2017

Copy link
Copy Markdown
Member

This ensure that the module gets created a link target added. The
trick is tell automodule to not document members.

This is slightly better than using the module directive as it at
least pulls the docstring.

closes #9331

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell
DOC: tweak template to use automodule (not currentmodule)
af78e98 
This ensure that the module gets created a link target added.  The
trick is tell `automodule` to not document members.

This is slightly better than using the `module` directive as it at
least pulls the docstring.
@tacaswell tacaswell added this to the 2.1.0-docs milestone Oct 13, 2017
anntzer
anntzer previously requested changes Oct 13, 2017
View reviewed changes

@anntzer anntzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Result looks a bit weird? https://2168-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/index.html (scroll to bottom)

@tacaswell

tacaswell commented Oct 13, 2017

Copy link
Copy Markdown
Member Author

Compare to http://matplotlib.org/api/index.html At least now the link is live!

@anntzer
anntzer dismissed their stale review October 13, 2017 19:32

see comment

@anntzer

anntzer commented Oct 13, 2017

Copy link
Copy Markdown
Contributor

Indeed. But can you not put the link on http://matplotlib.org/api/pyplot_summary.html instead?
(Not going to block on this as the PR is already an improvement but that'd be better).

@QuLogic
QuLogic merged commit c13aeda into matplotlib:v2.1.0-doc Oct 13, 2017
@tacaswell
tacaswell deleted the doc_fix_inventory branch October 13, 2017 21:23
@tacaswell

tacaswell commented Oct 13, 2017

Copy link
Copy Markdown
Member Author

Yes, that is probably a better place for that.

@tacaswell tacaswell mentioned this pull request Oct 13, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anntzer anntzer anntzer left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v2.1.0-doc

Development

Successfully merging this pull request may close these issues.

3 participants

@tacaswell @anntzer @QuLogic