Update changelog documentation file to link to Github and Jira issues

apache / libcloud

Apache Libcloud is a Python library which hides differences between different cloud provider APIs and allows you to manage different cloud resources through a unified and easy to use API.

https://libcloud.apache.org

Apache License 2.0

2.03k stars 929 forks source link

Update changelog documentation file to link to Github and Jira issues #1933

Closed Kami closed 11 months ago

Kami commented 11 months ago

This pull request updates Sphinx documentation config to link issue mentions in the changelog file to the corresponding Github or Jira issue.

It supports the following changelog file syntax / notation:

For github issues / prs: GITHUB-<number>, #<number>
For Jira: LIBCLOUD-<num>

Before:

Screenshot from 2023-08-07 22-10-08

After:

Screenshot from 2023-08-07 22-07-41

It also updates the local docs build to utilize RTD Sphinx theme so local and RTD builds are a bit more consistent and similar.

codecov-commenter commented 11 months ago

Codecov Report

Merging #1933 (b05fadc) into trunk (4369208) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##            trunk    #1933   +/-   ##
=======================================
  Coverage   83.12%   83.12%           
=======================================
  Files         353      353           
  Lines       81387    81387           
  Branches     8601     8601           
=======================================
  Hits        67652    67652           
  Misses      10931    10931           
  Partials     2804     2804