diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc index 67fc493e3e..ce7f498d80 100644 --- a/docs/src/common_links.inc +++ b/docs/src/common_links.inc @@ -38,6 +38,7 @@ .. _using git: https://docs.github.com/en/github/using-git .. _requirements/ci/: https://github.com/SciTools/iris/tree/main/requirements/ci .. _CF-UGRID: https://ugrid-conventions.github.io/ugrid-conventions/ +.. _issues on GitHub: https://github.com/SciTools/iris/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc .. comment diff --git a/docs/src/conf.py b/docs/src/conf.py index db2cdc3633..9c379ea730 100644 --- a/docs/src/conf.py +++ b/docs/src/conf.py @@ -302,6 +302,15 @@ def _dotv(version): html_static_path = ["_static"] html_style = "theme_override.css" +# this allows for using datatables: https://datatables.net/ +html_css_files = [ + "https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css", +] + +html_js_files = [ + "https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js", +] + # url link checker. Some links work but report as broken, lets ignore them. # See https://www.sphinx-doc.org/en/1.2/config.html#options-for-the-linkcheck-builder linkcheck_ignore = [ diff --git a/docs/src/index.rst b/docs/src/index.rst index e6a787a220..d247b93411 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -165,3 +165,4 @@ For **Iris 2.4** and earlier documentation please see the generated/api/iris techpapers/index copyright + voted_issues diff --git a/docs/src/voted_issues.rst b/docs/src/voted_issues.rst new file mode 100644 index 0000000000..edc1c860a2 --- /dev/null +++ b/docs/src/voted_issues.rst @@ -0,0 +1,55 @@ +.. include:: common_links.inc + +.. _voted_issues: + +Voted Issues +============ + +You can help us to prioritise development of new features by leaving a 👍 +reaction on the header (not subsequent comments) of any issue. + +.. tip:: We suggest you subscribe to the issue so you will be updated. + When viewing the issue there is a **Notifications** + section where you can select to subscribe. + +Below is a sorted table of all issues that have 1 or more 👍 from our github +project. Please note that there is more development activity than what is on +the below table. + +.. _voted-issues.json: https://github.com/scitools/voted_issues/blob/main/voted-issues.json + +.. raw:: html + + + + + + + + + + +
👍IssueAuthorTitle
+ + + + +

+ +.. note:: The data in this table is updated daily and is sourced from + `voted-issues.json`_. + For the latest data please see the `issues on GitHub`_. + Note that the list on Github does not show the number of votes 👍 + only the total number of comments for the whole issue. \ No newline at end of file diff --git a/docs/src/whatsnew/dev.rst b/docs/src/whatsnew/dev.rst index b9d5989bfc..6987d4219c 100644 --- a/docs/src/whatsnew/dev.rst +++ b/docs/src/whatsnew/dev.rst @@ -72,7 +72,8 @@ This document explains the changes made to Iris for this release 📚 Documentation ================ -#. N/A +#. `@tkknight`_ added a page to show the issues that have been voted for. See + :ref:`voted_issues`. (:issue:`3307`, :pull:`4617`) 💼 Internal