Merge branch 'main' into subplot_font

Author: emilykl

.circleci/config.yml

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a bug report for a plotly.py issue
+title: "[BUG]: "
+labels: bug
+
+---
+
+### Instructions (remove this section before submitting report)
+
+Thanks for your interest in plotly.py!
+
+- Before submitting a new bug report, please search for existing and closed issues. If your bug is not addressed yet, fill out the sections below and submit a new issue.
+- Implementation questions ("How do I do ...?") should be asked on our [Community Forum](https://community.plotly.com/c/plotly-python/5) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/plotly) (tagged 'plotly').
+- Comments should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead.
+
+### Description
+
+_Add a clear description of the issue that you're having._
+
+### Screenshots/Video
+
+_Add screenshots or a video of the issue._
+
+### Steps to reproduce
+
+_Reports **must** include steps to reproduce the issue. Please use the [latest version](https://github.com/plotly/plotly.py/releases) of plotly.py in your report unless not applicable._
+
+- Go to '...'
+- Click on X
+- Note the issue with Y
+
+### Notes
+
+_Add info here that doesn't fit in the other sections._

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,31 @@
+---
+name: Feature request
+about: Submit a new feature request for plotly.py
+title: "[FEATURE]: "
+labels: feature
+
+---
+
+### Instructions (remove this section before submitting an issue)
+
+Thanks for your interest in plotly.py!
+
+- Before submitting a new feature request, please search for existing and closed requests. If your request is novel, fill out the sections below and submit a new request.
+- Comments should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead.
+
+### Description
+
+_Add a clear description of the feature that you're requesting._
+
+
+### Why should this feature be added?
+
+_Provide an argument for why this feature should be added. We can't add everything, so this will help us determine what gets worked on. Please also consider creating a PR and adding the feature yourself. Help is always appreciated._
+
+### Mocks/Designs
+
+_Please add any mocks or designs you might have for the feature._
+
+### Notes
+
+_Add info here that doesn't fit in the other sections._

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+name: Set up Chrome for pytest
+description: Install Chrome/Chromedriver, set BROWSER, and verify the setup
+runs:
+  using: composite
+  steps:
+    - name: Set up Chrome
+      id: setup-chrome
+      uses: browser-actions/setup-chrome@4f8e94349a351df0f048634f25fec36c3c91eded  # v2.1.1
+      with:
+        install-chromedriver: true
+    - name: Set BROWSER env var
+      shell: bash
+      run: |
+        echo "BROWSER=${{ steps.setup-chrome.outputs.chrome-path }}" >> $GITHUB_ENV
+    - name: Check Chrome setup
+      shell: bash
+      run: |
+        CHROME_PATH="${{ steps.setup-chrome.outputs.chrome-path }}"
+        CHROMEDRIVER_PATH="${{ steps.setup-chrome.outputs.chromedriver-path }}"
+        echo "Chrome path: $CHROME_PATH"
+        echo "Chrome version: $($CHROME_PATH --version)"
+        echo "Chromedriver path: $CHROMEDRIVER_PATH"
+        echo "Chromedriver version: $($CHROMEDRIVER_PATH --version)"
+        echo "chrome --version: $(chrome --version)"
+        echo "BROWSER = $BROWSER"
+        python -c "import webbrowser; webbrowser.register_standard_browsers(); print(webbrowser._tryorder)"
+        python -c "import webbrowser; webbrowser.get()"

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,38 +1,30 @@
 <!--
-Please uncomment this block and fill in this checklist if your PR makes substantial changes to documentation in the `doc` directory.
-Not all boxes must be checked for every PR:
-check those that apply to your PR and leave the rest unchecked to discuss with your reviewer.
-
-If your PR modifies code of the `plotly` package, we have a different checklist below.
-
-## Documentation PR
-
-- [ ] I have seen the [`doc/README.md`](https://github.com/plotly/plotly.py/blob/main/doc/README.md) file.
-- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `main` branch.
-- [ ] If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible.
-- [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph.
-- [ ] Every new/modified example is independently runnable.
-- [ ] Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized.
-- [ ] Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible.
-- [ ] The random seed is set if using randomly-generated data.
-- [ ] New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets.
-- [ ] Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations.
-- [ ] Imports are `plotly.graph_objects as go`, `plotly.express as px`, and/or `plotly.io as pio`.
-- [ ] Data frames are always called `df`.
-- [ ] `fig = <something>` is called high up in each new/modified example (either `px.<something>` or `make_subplots` or `go.Figure`).
-- [ ] Liberal use is made of `fig.add_*` and `fig.update_*` rather than `go.Figure(data=..., layout=...)`.
-- [ ] Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls.
-- [ ] `fig.show()` is at the end of each example.
-- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any example.
-- [ ] Named colors are used instead of hex codes wherever possible.
-- [ ] Code blocks are marked with `&#96;&#96;&#96;python`.
-
-## Code PR
-
-- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the code generator and *not* the generated files.
-- [ ] I have added tests or modified existing tests.
-- [ ] For a new feature, I have added documentation examples (please see the doc checklist as well).
-- [ ] I have added a CHANGELOG entry if changing anything substantial.
-- [ ] For a new feature or a change in behavior, I have updated the relevant docstrings in the code.
+Thank you for your contribution to plotly.py!
 
+Please complete each section below.
 -->
+
+### Link to issue
+<!-- Link to the issue closed by this PR. If the issue doesn't exist yet, create it. -->
+
+Closes #(issue number)
+
+### Description of change
+<!-- Provide a clear 1-2 sentence description of what this PR does. -->
+
+### Demo
+
+<!-- Include screenshots or screen recordings of this PR in action. -->
+
+### Testing strategy
+
+<!-- Provide 1-2 sentences explaining tests added or changed by this PR. If testing changes are not needed, explain why. -->
+
+### Additional information (optional)
+
+<!-- Include any additional context, background, or explanation which doesn't fit in the previous sections. -->
+
+### Guidelines
+
+- [ ] I have reviewed the [pull request guidelines](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md#opening-a-pull-request) and the [Code of Conduct](https://github.com/plotly/plotly.py/blob/main/CODE_OF_CONDUCT.md) and confirm that this PR follows them.
+- [ ] I have added an entry to the [changelog](https://github.com/plotly/plotly.py/blob/main/CHANGELOG.md) if needed (not required for documentation PRs).

.github/actions/setup-chrome-for-pytest/action.yml

@@ -0,0 +1,156 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - doc-prod
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  build-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57  # v8.0.0
+        with:
+          python-version: "3.9"
+
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install rename
+
+      - name: Install doc dependencies
+        run: |
+          cd doc
+          uv venv
+          source .venv/bin/activate
+          uv pip install -r requirements.txt
+
+      - name: Install plotly in editable mode
+        if: github.ref_name != 'doc-prod'
+        run: |
+          cd doc
+          source .venv/bin/activate
+          uv pip uninstall plotly
+          uv pip install -e ..
+
+
+      - name: Build HTML docs
+        env:
+          MAPBOX_TOKEN: ${{ secrets.MAPBOX_TOKEN }}
+        run: |
+          cd doc
+          source .venv/bin/activate
+          echo "${MAPBOX_TOKEN}" > python/.mapbox_token
+          make -kj8 || make -kj8
+          curl https://raw.githubusercontent.com/plotly/graphing-library-docs/master/front-matter-ci.py > front-matter-ci.py
+          curl https://raw.githubusercontent.com/plotly/graphing-library-docs/master/check-or-enforce-order.py > check-or-enforce-order.py
+          python front-matter-ci.py build/html
+          python check-or-enforce-order.py build/html
+
+      - name: Upload HTML docs artifact
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
+        with:
+          name: doc-html
+          path: doc/build/html/
+
+      - name: Create GitHub App token
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3  # v3.1.1
+        id: app-token
+        with:
+          app-id: ${{ vars.GRAPHING_LIBRARIES_CI_GHAPP_ID }}
+          private-key: ${{ secrets.GRAPHING_LIBRARIES_CI_GHAPP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+          repositories: plotly.py-docs,graphing-library-docs
+
+      - name: Checkout plotly.py-docs (built)
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          repository: plotly/plotly.py-docs
+          ref: built
+          token: ${{ steps.app-token.outputs.token }}
+          path: plotly.py-docs-html
+
+      - name: Deploy HTML docs
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        run: |
+          git config --global user.name plotlydocbot
+          git config --global user.email accounts@plot.ly
+          rm -rf plotly.py-docs-html/*
+          cp -r doc/build/html/* plotly.py-docs-html/
+          cd plotly.py-docs-html
+          git add .
+          git commit -m "build of https://github.com/plotly/plotly.py/commit/${{ github.sha }}" || echo "No changes to commit"
+          git push --force
+
+      - name: Checkout plotly.py-docs (built_ipynb)
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          repository: plotly/plotly.py-docs
+          ref: built_ipynb
+          token: ${{ steps.app-token.outputs.token }}
+          path: plotly.py-docs-ipynb
+
+      - name: Deploy notebooks
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        run: |
+          rm -rf plotly.py-docs-ipynb/*
+          cp -r doc/build/ipynb/* plotly.py-docs-ipynb/
+          cd plotly.py-docs-ipynb
+          git add .
+          git commit -m "build of https://github.com/plotly/plotly.py/commit/${{ github.sha }}" || echo "No changes to commit"
+          git push --force
+
+      - name: Checkout graphing-library-docs
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          repository: plotly/graphing-library-docs
+          ref: master
+          token: ${{ steps.app-token.outputs.token }}
+          path: graphing-library-docs
+
+      - name: Trigger downstream doc build
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        run: |
+          cd graphing-library-docs
+          git commit --allow-empty -m "deploying https://github.com/plotly/plotly.py/commit/${{ github.sha }}"
+          git push
+
+      - name: Build API docs
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        run: |
+          cd doc
+          source .venv/bin/activate
+          # For the API doc, we need to use the local version of plotly
+          # since we are tweaking the source because of
+          # graph_objs/graph_objects
+          uv pip uninstall plotly
+          uv pip install -e ..
+          cd apidoc
+          make html
+
+      - name: Checkout plotly.py-docs (gh-pages)
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          repository: plotly/plotly.py-docs
+          ref: gh-pages
+          token: ${{ steps.app-token.outputs.token }}
+          path: plotly.py-docs-api
+
+      - name: Deploy API docs
+        if: github.ref_name == 'doc-prod' && github.event_name == 'push'
+        run: |
+          rm -rf plotly.py-docs-api/*
+          cp -r doc/apidoc/_build/html/* plotly.py-docs-api/
+          touch plotly.py-docs-api/.nojekyll
+          cd plotly.py-docs-api
+          git add .
+          git commit -m "build of https://github.com/plotly/plotly.py/commit/${{ github.sha }}" || echo "No changes to commit"
+          git push --force