8000 Update versions and expose in documentation by Coderambling · Pull Request #7447 · holoviz/panel · GitHub
[go: up one dir, main page]

Skip to content

Conversation

@Coderambling
Copy link
Collaborator
@Coderambling Coderambling commented Oct 27, 2024

See below PR where this was implemented for Tabulator doc.

Added version numbers for the following:

Deck.gl/ PyDeck, Echarts/ PyEcharts, Katex/ MathJax, Plotly, Altair & Vega.

#7053

References need to be added / updated in the various docs for the respective libraries to dynamically show the library version numbers.

Example doc snippet that uses this:

The library is built on version {{TABULATOR_VERSION}} of Tabulator

…sion numbers can be referred to dynamically in various docs


See below PRwhere this was implemented for Tabulator doc.

holoviz#7053
@Coderambling Coderambling changed the title Update conf.py to retrieve version numbers for various libraries, so they can be referred to dynamucally in various docs Update conf.py to retrieve version numbers for various libraries, so they can be referred to dynamically in various docs Oct 27, 2024
Copy link
Member
@philippjfr philippjfr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. Most of these version variables don't exist yet and would have to be defined. We then also need to use these versions consistently across the docs.

@codecov
Copy link
codecov bot commented Sep 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.92%. Comparing base (a92eb07) to head (f5ad3a5).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7447      +/-   ##
==========================================
- Coverage   87.37%   86.92%   -0.46%     
==========================================
  Files         348      348              
  Lines       53843    53923      +80     
==========================================
- Hits        47045    46870     -175     
- Misses       6798     7053     +255     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@philippjfr philippjfr changed the title Update conf.py to retrieve version numbers for various libraries, so they can be referred to dynamically in various docs Update versions and expose in documentation Sep 7, 2025
@philippjfr philippjfr merged commit 4619417 into holoviz:main Sep 7, 2025
18 checks passed
Coderambling added a commit to Coderambling/panel that referenced this pull request Sep 12, 2025
…rsion


Now that holoviz#7447 has been merged, versions of libraries used by Panel can be referred to dynamically in the docs.

This PR is a first iteration of this. It adds the sentence:

Panel uses Plotly version x.

To the docs, by adding the code line:

 "Panel uses [Plotly](https://plotly.com/python/) **version {{PLOTLY_VERSION}}** \n",
    "\n",


Suggestions for alternate / improved phrasing are very welcome. Please chime in @philippjfr , @MarcSkovMadsen , @hoxbro if you have suggestions.

Once the optimal phrasing has emerged, the intention is to apply it to other reference docs, to ensure uniformity between docs.

The intention is  to submit those subsequent doc changes as 1 PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

0