iiasa / ixmp

The ix modeling platform for integrated and cross-cutting scenario analysis
https://docs.messageix.org/ixmp
Apache License 2.0
37 stars 110 forks source link

Add `.utils.sphinx_linkcode_github` #459

Closed khaeru closed 1 year ago

khaeru commented 1 year ago

Based on this code example, this extends sphinx.ext.autocode and sphinx.ext.linkcode to link to file source on GitHub.

This will obviate the need to use sphinx.ext.viewcode on ixmp stack repositories.

How to review

PR checklist

codecov[bot] commented 1 year ago

Codecov Report

Merging #459 (3074cd1) into main (13b73e6) will increase coverage by 0.0%. The diff coverage is 100.0%.

@@          Coverage Diff          @@
##            main    #459   +/-   ##
=====================================
  Coverage   98.6%   98.6%           
=====================================
  Files         42      42           
  Lines       4467    4468    +1     
=====================================
+ Hits        4405    4406    +1     
  Misses        62      62           
Impacted Files Coverage Δ
ixmp/backend/__init__.py 100.0% <ø> (ø)
ixmp/backend/io.py 98.5% <ø> (ø)
ixmp/utils/__init__.py 99.5% <ø> (ø)
ixmp/testing/__init__.py 95.9% <100.0%> (+<0.1%) :arrow_up: