radical-cybertools / radical.pilot

RADICAL-Pilot
http://radical-cybertools.github.io/radical-pilot/index.html
Other
54 stars 23 forks source link

Provide a target for Sphinx `:py:mod:` role. #2977

Closed eirrgang closed 1 year ago

eirrgang commented 1 year ago

Establish a docutils target for radical.pilot. Allows the root package module to be linked from inside or outside of the project (via intersphinx through the objects.inv file).

codecov[bot] commented 1 year ago

Codecov Report

Merging #2977 (e36c412) into devel (2065008) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##            devel    #2977   +/-   ##
=======================================
  Coverage   41.62%   41.62%           
=======================================
  Files          95       95           
  Lines       10506    10506           
=======================================
  Hits         4373     4373           
  Misses       6133     6133           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

eirrgang commented 1 year ago

There is no module docstring in radical/pilot/__init__.py and there doesn't seem to be a better target for links to radical.pilot. It is not unusual for projects with mostly-prose documentation to just let the package module docutils target point to the top of the index page, and that seems appropriate here.