8000 Enable sphinx.ext.viewcode by timhoffm · Pull Request #11063 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Enable sphinx.ext.viewcode #11063

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
Merged
merged 1 commit into from
Apr 18, 2018
Merged

Enable sphinx.ext.viewcode #11063

merged 1 commit into from
Apr 18, 2018

Conversation

timhoffm
Copy link
Member

PR Summary

Closes #10676.

@tacaswell tacaswell added this to the v3.0 milestone Apr 17, 2018
@tacaswell
Copy link
Member

The built source is not rendering great:

https://9046-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/_modules/matplotlib/colorbar.html#Colorbar

@tacaswell
Copy link
Member

👍 on this though!

@timhoffm
Copy link
Member Author

The built source is not rendering great

What exactly are you referring to? The [docs] links, which shift the lines?

@QuLogic
Copy link
Member
QuLogic commented Apr 17, 2018 •
edited
Loading

You might be missing it because of the unreleased-Matplotlib header overlay, but the Colorbar class that @tacaswell linked is indented a bit and no longer aligned with the docstring on the next line.

@tacaswell
Copy link
Member

Yes, that [docs] links that shift the code.

@timhoffm timhoffm force-pushed the sphinx-ext-viewcode branch from c94dc47 to 28e6542 Compare April 17, 2018 12:55
@timhoffm
Copy link
Member Author

Fixed by copying css from the standard sphinx css files.

Is it intentional, that we maintain a complete css file of our own? Usually, I would use the basic sphinx css file and just add our own adaptions in an additional file.

@tacaswell
Copy link
Member

We started using sphinx very early which probably predated what are considered current best practices with both sphinx and css.

@timhoffm
Copy link
Member Author

Example for review

jklymak
jklymak approved these changes Apr 18, 2018
View reviewed changes
Copy link
Member
@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Looks great!

@jklymak
Copy link
Member
jklymak commented Apr 18, 2018

Any reason to not backport this?

@timhoffm
Copy link
Member Author

+1 on backporting

@jklymak jklymak modified the milestones: v3.0, v2.2-doc Apr 18, 2018
@tacaswell tacaswell merged commit f78ee3f into matplotlib:master Apr 18, 2018
@tacaswell
Copy link
Member

Thanks @timhoffm !

lumberbot-app bot pushed a commit that referenced this pull request Apr 18, 2018
@tacaswell
Backport PR #11063: Enable sphinx.ext.viewcode
aa55c96
@lumberbot-app lumberbot-app bot mentioned this pull request Apr 18, 2018
Merged
@timhoffm timhoffm deleted the sphinx-ext-viewcode branch April 18, 2018 23:38
timhoffm pushed a commit that referenced this pull request May 5, 2018
@tacaswell @timhoffm
Backport PR #11063: Enable sphinx.ext.viewcode
2b40cf3
jklymak added a commit that referenced this pull request May 9, 2018
@jklymak
Merge pull request #11082 from matplotlib/auto-backport-of-pr-11063
5a900e4 
Backport PR #11063 on branch v2.2.2-doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v2.2-doc
Development

Successfully merging this pull request may close these issues.
4 participants
@timhoffm @tacaswell @QuLogic @jklymak
0