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.

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

Add sphinx extension viewcode #2192

Merged
merged 4 commits into from
Feb 20, 2022
Merged

Add sphinx extension viewcode #2192

merged 4 commits into from
Feb 20, 2022

Conversation

tkoyama010
Copy link
Member

Overview

Add sphinx.ext.viewcode – Add links to highlighted source code

before after
image image

Details

  • None

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Feb 11, 2022
@tkoyama010 tkoyama010 marked this pull request as ready for review February 11, 2022 12:34
@tkoyama010 tkoyama010 enabled auto-merge (squash) February 11, 2022 12:35
@codecov
Copy link

codecov bot commented Feb 11, 2022 •
edited

Codecov Report

Merging #2192 (6e01dae) into main (135fedc) will decrease coverage by 0.06%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2192      +/-   ##
==========================================
- Coverage   93.37%   93.30%   -0.07%     
==========================================
  Files          75       75              
  Lines       15602    15602              
==========================================
- Hits        14568    14558      -10     
- Misses       1034     1044      +10

@tkoyama010 tkoyama010 mentioned this pull request Feb 11, 2022
Merged
@tkoyama010 tkoyama010 self-assigned this Feb 13, 2022
@tkoyama010 tkoyama010 marked this pull request as draft February 14, 2022 00:22
auto-merge was automatically disabled February 14, 2022 00:22

Pull request was converted to draft

@tkoyama010 tkoyama010 marked this pull request as ready for review February 14, 2022 00:23
@tkoyama010 tkoyama010 enabled auto-merge (squash) February 14, 2022 00:23
banesullivan
banesullivan approved these changes Feb 20, 2022
View reviewed changes
Copy link
Member

@banesullivan banesullivan left a comment

Choose a reason for hiding this comment

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

Generally, I am not a huge fan of this option as I prefer to look at the source code on GitHub... however I use this all the time and it is a nice-to-have feature

@tkoyama010 tkoyama010 merged commit 166ec63 into main Feb 20, 2022
@tkoyama010 tkoyama010 deleted the doc/ext.viewcode branch February 20, 2022 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@banesullivan banesullivan banesullivan approved these changes

Assignees

@tkoyama010 tkoyama010

Labels
documentation Anything related to the documentation/website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tkoyama010 @banesullivan