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 link to source code in the documentation #1195

Merged
merged 1 commit into from
Feb 7, 2024
Merged

Conversation

andrea-pasquale
Copy link
Contributor

@andrea-pasquale andrea-pasquale commented Feb 6, 2024

I've added the sphinx extension viewcode which allows to visualize the source code directly from the documentation.

After a quick discussion with @BrunoLiegiBastonLiegi we think that it would be useful to improve the quality of the documentation.

If we like this approach I can propagate it to the other repos.

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.

@andrea-pasquale andrea-pasquale added the documentation Improvements or additions to documentation label Feb 6, 2024
@andrea-pasquale andrea-pasquale self-assigned this Feb 6, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c113117) 100.00% compared to head (d8a56d0) 100.00%.
Report is 21 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #1195   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           69        69           
  Lines        10112     10112           
=========================================
  Hits         10112     10112           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MatteoRobbiati MatteoRobbiati added this pull request to the merge queue Feb 7, 2024
Merged via the queue into master with commit 8e9d1c0 Feb 7, 2024
21 checks passed
@scarrazza scarrazza deleted the show_source branch June 25, 2024 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants