search

canonical / canonical-sphinx

Extension and theme to create great Canonical-branded documentation
GNU Lesser General Public License v3.0
1 stars 3 forks source link

Add contributor listing #25

Open ru-fu opened 3 weeks ago

ru-fu commented 3 weeks ago

This PR adds the contributor listing that we recently added to the starter pack.

More precisely, the idea is to move the contributor listing to a separate extension (part of the canonical-sphinx-extensions package). The PR for this is https://github.com/canonical/canonical-sphinx-extensions/pull/41 - it needs to be merged before this PR can be merged.

I'll open a PR to the starter pack repo that can be used for testing this. I haven't managed to figure out how to make this extension depend on a package from a PR ... Update: https://canonical-starter-pack--250.com.readthedocs.build/

DOCPR-519

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 15.71%. Comparing base (5a4416e) to head (da5bb1a). Report is 21 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #25 +/- ## ============================================ - Coverage 100.00% 15.71% -84.29% ============================================ Files 1 3 +2 Lines 10 70 +60 Branches 2 12 +10 ============================================ + Hits 10 11 +1 - Misses 0 59 +59 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ru-fu commented 3 weeks ago

No idea what the linter is complaining about - I haven't changed that code. :( The tests and doc build are expected to fail (since canonical-sphinx-extensions hasn't been updated yet).

tigarmo commented 3 weeks ago

Hey I'll fix the unrelated linting errors. As for the missing canonical.contributor-listing, can we wait until canonical-sphinx-extensions is updated before merging this?

ru-fu commented 3 weeks ago

Hey I'll fix the unrelated linting errors. As for the missing canonical.contributor-listing, can we wait until canonical-sphinx-extensions is updated before merging this?

Yes, of course! I'll let you know when that PR is merged. Doesn't make sense to include this before it works. :)

ru-fu commented 3 days ago

@tigarmo canonical-sphinx-extensions is updated now, and https://github.com/canonical/sphinx-docs-starter-pack/pull/250 (which uses this PR here) looks as expected. :)