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

Use viewcode sphinx extension #851

Merged
merged 1 commit into from
Dec 15, 2020
Merged

Use viewcode sphinx extension #851

merged 1 commit into from
Dec 15, 2020

Conversation

rahulporuri
Copy link
Contributor

Using this extension means that API docs now link to source code. See example below which now includes the source button.

sphinx-viewcode

With the use of this extension, the api docs link to the source
code

	modified:   docs/source/conf.py
Copy link
Contributor

@aaronayres35 aaronayres35 left a comment

Choose a reason for hiding this comment

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

LGTM! I tested building the docs and it works as expected

@codecov-io
Copy link

codecov-io commented Dec 15, 2020

Codecov Report

Merging #851 (040a3f3) into master (92ab736) will increase coverage by 0.14%.
The diff coverage is 96.55%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #851      +/-   ##
==========================================
+ Coverage   41.15%   41.29%   +0.14%     
==========================================
  Files         522      522              
  Lines       28110    28126      +16     
  Branches     4251     4253       +2     
==========================================
+ Hits        11568    11614      +46     
+ Misses      16037    16015      -22     
+ Partials      505      497       -8     
Impacted Files Coverage Δ
pyface/action/action_event.py 100.00% <ø> (ø)
pyface/action/action_manager.py 83.92% <ø> (ø)
pyface/action/field_action.py 95.00% <ø> (ø)
pyface/tasks/action/listening_action.py 0.00% <0.00%> (ø)
pyface/tasks/action/schema.py 87.93% <ø> (ø)
pyface/tasks/action/schema_addition.py 100.00% <ø> (ø)
pyface/tasks/action/task_action.py 60.00% <ø> (ø)
pyface/tasks/action/task_action_controller.py 52.94% <ø> (ø)
pyface/tasks/action/task_action_manager_builder.py 91.96% <ø> (ø)
pyface/tasks/action/task_toggle_group.py 48.97% <ø> (ø)
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d13b91f...040a3f3. Read the comment docs.

@rahulporuri rahulporuri merged commit 7303be2 into master Dec 15, 2020
@rahulporuri rahulporuri deleted the doc/viewcode-ext branch December 15, 2020 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants