.. _ref_release_notes: Release notes ############# .. vale off .. towncrier release notes start `1.5.3 `_ (July 02, 2025) ========================================================================================== .. tab-set:: .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - Add the search button to ``navbar end`` by default - `#747 `_ `1.5.2 `_ (June 02, 2025) ========================================================================================== .. tab-set:: .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - remove font weight on highlight - `#721 `_ `1.5.1 `_ (June 02, 2025) ========================================================================================== .. tab-set:: .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - revert the main content style - `#714 `_ `1.5.0 `_ (May 28, 2025) ========================================================================================= .. tab-set:: .. tab-item:: Added .. list-table:: :header-rows: 0 :widths: auto * - add multi index searching and filtering - `#674 `_ * - small layout adjustments - `#691 `_ * - add customization instructions for SCSS files in developer documentation - `#694 `_ * - add 'serve' command to Makefile and make.bat for serving documentation - `#698 `_ .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - smaller screen view and search for mobile views - `#689 `_ * - style for back to top button - `#693 `_ * - url for fetch extra source file - `#707 `_ .. tab-item:: Documentation .. list-table:: :header-rows: 0 :widths: auto * - update the multi-index docs - `#708 `_ .. tab-item:: Dependencies .. list-table:: :header-rows: 0 :widths: auto * - bump notebook from 7.4.1 to 7.4.2 - `#684 `_ * - update snowballstemmer requirement from <3 to <4 - `#688 `_ * - bump pyvista[jupyter] from 0.45.0 to 0.45.1 - `#690 `_ * - bump pyvista[jupyter] from 0.45.1 to 0.45.2 - `#699 `_ * - bump tox from 4.25.0 to 4.26.0 - `#700 `_ * - bump plotly from 6.0.1 to 6.1.1 - `#701 `_ * - bump notebook from 7.4.2 to 7.4.3 - `#705 `_ * - bump plotly from 6.1.1 to 6.1.2 - `#709 `_ .. tab-item:: Maintenance .. list-table:: :header-rows: 0 :widths: auto * - update CHANGELOG for v1.4.5 - `#706 `_ `1.4.5 `_ (May 27, 2025) ========================================================================================= .. tab-set:: .. tab-item:: Added .. list-table:: :header-rows: 0 :widths: auto * - add deprecated warning for `index_pattern` search option - `#704 `_ `1.4.4 `_ (May 08, 2025) ========================================================================================= .. tab-set:: .. tab-item:: Added .. list-table:: :header-rows: 0 :widths: auto * - add metatag content - `#680 `_ .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - block snowbalstemmer <3 for now - `#686 `_ .. tab-item:: Documentation .. list-table:: :header-rows: 0 :widths: auto * - Update ``CONTRIBUTORS.md`` with the latest contributors - `#669 `_, `#677 `_ .. tab-item:: Dependencies .. list-table:: :header-rows: 0 :widths: auto * - bump tox from 4.24.2 to 4.25.0 - `#668 `_ * - bump pyvista[jupyter] from 0.44.2 to 0.45.0 - `#675 `_ * - bump notebook from 7.3.3 to 7.4.1 - `#676 `_ * - bump jupytext from 1.16.7 to 1.17.1 - `#678 `_ .. tab-item:: Maintenance .. list-table:: :header-rows: 0 :widths: auto * - add github token - `#661 `_ * - update CHANGELOG for v1.4.0 - `#662 `_ * - bump version 1.5.dev0 - `#663 `_ * - update CHANGELOG for v1.4.1 - `#665 `_ * - bump ansys/actions from 8 to 9 in the actions group - `#670 `_ `1.4.3 `_ (May 07, 2025) ========================================================================================= .. tab-set:: .. tab-item:: Added .. list-table:: :header-rows: 0 :widths: auto * - add metatag content - `#680 `_ .. tab-item:: Maintenance .. list-table:: :header-rows: 0 :widths: auto * - bump ansys/actions from 8 to 9 in the actions group - `#670 `_ `1.4.2 `_ (March 27, 2025) =========================================================================================== .. tab-set:: .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - autoapi child class template - `#666 `_ `1.4.1 `_ (March 27, 2025) =========================================================================================== .. tab-set:: .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - quarto std logging - `#664 `_ `1.4.0 `_ (March 27, 2025) =========================================================================================== .. tab-set:: .. tab-item:: Added .. list-table:: :header-rows: 0 :widths: auto * - enable matplotlib and plotly in examples - `#567 `_ * - feat: add python 3.13 support - `#635 `_ * - feat: Add Tox environment for documentation preview - `#642 `_ * - migrate css to scss - `#644 `_ .. tab-item:: Fixed .. list-table:: :header-rows: 0 :widths: auto * - update the style for highlight name function - `#652 `_ * - update the changelog action only for PR - `#654 `_ * - change logging info to error in quarto build - `#655 `_ * - quarto error logging - `#658 `_ .. tab-item:: Documentation .. list-table:: :header-rows: 0 :widths: auto * - chore: update CHANGELOG for v1.3.0 - `#614 `_ * - chore: update CHANGELOG for v1.3.1 - `#618 `_ * - chore: update CHANGELOG for v1.3.2 - `#631 `_ * - docs: add contribute section - `#636 `_ * - docs: add contribute page in toctree - `#638 `_ * - chore: update CHANGELOG for v1.3.3 - `#648 `_ .. tab-item:: Dependencies .. list-table:: :header-rows: 0 :widths: auto * - chore(deps): bump jupytext from 1.16.6 to 1.16.7 - `#622 `_ * - chore(deps): bump sphinx-autoapi from 3.4.0 to 3.5.0 - `#623 `_ * - chore(deps): bump sphinx-gallery from 0.18.0 to 0.19.0 - `#625 `_ * - chore(deps): bump pygithub from 2.5.0 to 2.6.0 - `#626 `_ * - chore(deps): bump sphinx from 8.1.3 to 8.2.0 - `#628 `_ * - chore(deps): bump sphinx-autoapi from 3.5.0 to 3.6.0 - `#629 `_ * - build: bump nbsphinx from 0.9.6 to 0.9.7 - `#637 `_ * - build: bump tox from 4.24.1 to 4.24.2 - `#645 `_ * - build: bump notebook from 7.3.2 to 7.3.3 - `#651 `_ .. tab-item:: Maintenance .. list-table:: :header-rows: 0 :widths: auto * - feat: migrate the builds system to stb - `#639 `_ .. tab-item:: Miscellaneous .. list-table:: :header-rows: 0 :widths: auto * - chore: bump version 1.4.dev0 - `#615 `_ * - fix: remove flake8 configuration file - `#641 `_ * - fix: improve Logging in Quarto cheatsheet build process - `#646 `_ * - cheatsheet and whatsnew functions into separate modules and implement sidebar ordering - `#656 `_ * - ansys sphinx theme variables - `#657 `_ `1.3.3 `_ (March 11, 2025) =========================================================================================== Dependencies ^^^^^^^^^^^^ - chore(deps): bump pygithub from 2.6.0 to 2.6.1 `#632 `_ Miscellaneous ^^^^^^^^^^^^^ - fix: alignment and styles for primary sidebar `#621 `_ - fix: typo in autoapi template `#630 `_ Documentation ^^^^^^^^^^^^^ - Fix: whatsnew config instructions `#619 `_ Maintenance ^^^^^^^^^^^ - fix: prettier pre-commit hook `#627 `_ `1.3.1 `_ (2025-02-06) ======================================================================================= Documentation ^^^^^^^^^^^^^ - Fix: optimize imports for whatsnew `#617 `_ `1.3.0 `_ (2025-02-05) ======================================================================================= Dependencies ^^^^^^^^^^^^ - chore(deps): bump pygithub from 2.4.0 to 2.5.0 `#582 `_ - chore(deps): bump pyvista[jupyter] from 0.44.1 to 0.44.2 `#589 `_ - chore(deps): bump sphinx-autoapi from 3.3.3 to 3.4.0 `#592 `_ - chore(deps): bump notebook from 7.2.2 to 7.3.1 `#596 `_ - chore(deps): bump jupytext from 1.16.4 to 1.16.5 `#598 `_ - chore(deps): bump jupytext from 1.16.5 to 1.16.6 `#600 `_ - chore(deps): bump notebook from 7.3.1 to 7.3.2 `#606 `_ - chore(deps): bump nbsphinx from 0.9.5 to 0.9.6 `#607 `_ - chore(deps): bump sphinx-notfound-page from 1.0.4 to 1.1.0 `#611 `_ Miscellaneous ^^^^^^^^^^^^^ - chore: bump version 1.3.dev0 `#577 `_ - fix: CONTRIBUTORS.md `#578 `_ - fix: errors and warnings caused by CSS imports `#588 `_ - fix: typo in date variable for last modified `#602 `_ - chore: update CHANGELOG for v1.2.5 `#609 `_ Documentation ^^^^^^^^^^^^^ - chore: update CHANGELOG for v1.2.0 `#576 `_ - feat: add whatsnew options `#583 `_ - chore: update CHANGELOG for v1.2.1 `#585 `_ - chore: update CHANGELOG for v1.2.2 `#587 `_ - chore: update CHANGELOG for v1.2.3 `#595 `_ - chore: update CHANGELOG for v1.2.4 `#604 `_ - chore: update CHANGELOG for v1.2.7 `#613 `_ Maintenance ^^^^^^^^^^^ - fix: style and license headers `#608 `_ `1.2.7 `_ - 2025-02-04 ======================================================================================= Maintenance ^^^^^^^^^^^ - fix: astroid version `#612 `_ `1.2.5 `_ - 2025-01-13 ======================================================================================= Dependencies ^^^^^^^^^^^^ - chore(deps): update pydata-sphinx-theme requirement from <0.16,>=0.15.4 to >=0.15.4,<0.17 `#605 `_ `1.2.4 `_ - 2024-12-20 ======================================================================================= Miscellaneous ^^^^^^^^^^^^^ - fix: impose upper version for the pydata-sphinx-theme `#603 `_ `1.2.3 `_ - 2024-12-05 ======================================================================================= Miscellaneous ^^^^^^^^^^^^^ - fix: rename the ``date`` to ``ast_build_date`` in js `#594 `_ `1.2.2 `_ - 2024-11-21 ======================================================================================= Miscellaneous ^^^^^^^^^^^^^ - fix: section ids with search `#586 `_ `1.2.1 `_ - 2024-11-13 ======================================================================================= Miscellaneous ^^^^^^^^^^^^^ - fix: enable local page `Search` and default to PyData search on 'Enter' `#584 `_ Documentation ^^^^^^^^^^^^^ - Enable 'show_prev_next' in the documented defaults `#580 `_ `1.2.0 `_ - 2024-10-31 ======================================================================================= Fixed ^^^^^ - fix: contributors file `#529 `_ - fix: padding for toctree entry in sidebar `#554 `_ - fix: revisit header size `#555 `_ Dependencies ^^^^^^^^^^^^ - chore: bump version 1.2.dev0 `#518 `_ - chore(deps): bump sphinx-gallery from 0.17.1 to 0.18.0 `#538 `_ - chore(deps): bump sphinx from 8.0.2 to 8.1.3 `#546 `_ - chore(deps): update pydata-sphinx-theme requirement from <0.16,>=0.15.4 to >=0.15.4,<0.17 `#562 `_ - chore(deps): bump sphinx-autoapi from 3.3.2 to 3.3.3 `#569 `_ Miscellaneous ^^^^^^^^^^^^^ - fix: cleanup autoapi templates using macros `#556 `_ - fix: typos `#560 `_ - fix: change the display of math rendering `#568 `_ Documentation ^^^^^^^^^^^^^ - chore: update CHANGELOG for v1.1.0 `#516 `_ - chore: update CHANGELOG for v1.1.1 `#520 `_ - chore: update CHANGELOG for v1.1.2 `#522 `_ - docs: adding ``title`` in example section `#524 `_ - fix: add more components to the search indexing `#541 `_ - chore: update CHANGELOG for v1.1.3 `#545 `_ - chore: update CHANGELOG for v1.1.4 `#547 `_ - chore: update CHANGELOG for v1.1.5 `#550 `_ - doc: allow developer to skip examples build `#553 `_ - chore: update CHANGELOG for v1.1.6 `#559 `_ - docs: update the landing page `#561 `_ - chore: update CHANGELOG for v1.1.7 `#566 `_ - fix: exclude search files `#572 `_ Maintenance ^^^^^^^^^^^ - ci: bump ansys/actions from 7 to 8 `#530 `_ - chore: add hacktoberfest labels `#535 `_ - ci: add new labels `#549 `_ - ci: update labeling strategy `#558 `_ `1.1.7 `_ - 2024-10-23 ======================================================================================= Miscellaneous ^^^^^^^^^^^^^ - fix: ensure app.builder.outdir is a Path object `#565 `_ `1.1.6 `_ - 2024-10-18 ======================================================================================= Fixed ^^^^^ - fix: add the default search options in the config env `#557 `_ `1.1.5 `_ - 2024-10-15 ======================================================================================= Fixed ^^^^^ - use ansys-sphinx-theme variables in CSS files `#537 `_ `1.1.4 `_ - 2024-10-14 ======================================================================================= Fixed ^^^^^ - fix: static search performance `#525 `_ `1.1.3 `_ - 2024-10-11 ======================================================================================= Fixed ^^^^^ - fix: add default `enter` for search `#542 `_ `1.1.2 `_ - 2024-10-02 ======================================================================================= Fixed ^^^^^ - fix: add version as params in cheatsheet `#521 `_ `1.1.1 `_ - 2024-10-01 ======================================================================================= Fixed ^^^^^ - fix(ci): update to Ansys actions v8 `#517 `_ - fix: update the token and email of bot for changelog actions `#519 `_ `1.1.0 `_ - 2024-10-01 ======================================================================================= Added ^^^^^ - feat: add static search `#487 `_ Changed ^^^^^^^ - chore: update CHANGELOG for v1.0.0 `#445 `_ - chore: update CHANGELOG for v1.0.1 `#447 `_ - chore: update CHANGELOG for v1.0.2 `#451 `_ - chore: update CHANGELOG for v1.0.3 `#455 `_ Fixed ^^^^^ - maint: update tooling, cleanup and drop python 3.9 `#484 `_ - feat: implement default search bar expansion behavior `#496 `_ - fix: the anchor url of search with the switcher version `#497 `_ - fix: change file location for `search.json` file `#509 `_ - maint: styles for dark theme search bar `#511 `_ - fix: style for smaller media `#513 `_ - fix: navigation end columns `#514 `_ - fix: add title breadcrumbs `#515 `_ Dependencies ^^^^^^^^^^^^ - maint: version 1.1.dev0 `#448 `_ - build(deps): bump pygithub from 2.3.0 to 2.4.0 `#480 `_ - build(deps): bump notebook from 7.2.1 to 7.2.2 `#482 `_ - build(deps): bump sphinx-autoapi from 3.2.1 to 3.3.0 `#485 `_ - build(deps): bump sphinx-autoapi from 3.3.0 to 3.3.1 `#488 `_ - build(deps): bump pandas from 2.2.2 to 2.2.3 `#508 `_ - build(deps): bump sphinx-autoapi from 3.3.1 to 3.3.2 `#512 `_ Documentation ^^^^^^^^^^^^^ - chore: update CHANGELOG for v1.0.4 `#463 `_ - chore: update CHANGELOG for v1.0.6 `#476 `_ - chore: update CHANGELOG for v1.0.7 `#478 `_ - chore: update CHANGELOG for v1.0.8 `#491 `_ - chore: update CHANGELOG for v1.0.9 `#501 `_ - chore: update CHANGELOG for v1.0.10 `#504 `_ - chore: update CHANGELOG for v1.0.11 `#507 `_ `1.0.11 `_ - 2024-09-19 ========================================================================================= Fixed ^^^^^ - fix: location of nbsphinx `#506 `_ `1.0.10 `_ - 2024-09-18 ========================================================================================= Fixed ^^^^^ - fix: do not display captions for nbgallery `#503 `_ `1.0.9 `_ - 2024-09-16 ======================================================================================= Added ^^^^^ - feat: add member_order to autoapi `#495 `_ Fixed ^^^^^ - fix: ``autoapi`` relative directory path wrt ``tox`` env `#494 `_ `1.0.8 `_ - 2024-09-03 ======================================================================================= Fixed ^^^^^ - fix: Align jupyter cell output `#489 `_ - fix: the download in sphinx gallery `#490 `_ `1.0.7 `_ - 2024-08-23 ======================================================================================= Fixed ^^^^^ - fix: autoapi extension `#472 `_ - fix: admonitions styles for ``topic`` admonition `#477 `_ `1.0.6 `_ - 2024-08-23 ======================================================================================= Fixed ^^^^^ - fix: download icon with sphinx-gallery and nbsphinx `#471 `_ - feat: add different width for different media for main content `#473 `_ - fix: the scrollbar on sidebar `#474 `_ Documentation ^^^^^^^^^^^^^ - chore: update CHANGELOG for v1.0.5 `#470 `_ `1.0.5 `_ - 2024-08-16 ======================================================================================= Fixed ^^^^^ - feat: add default logo links for Ansys and PyAnsys logos `#469 `_ Dependencies ^^^^^^^^^^^^ - build(deps): bump nbsphinx from 0.9.4 to 0.9.5 `#465 `_ `1.0.4 `_ - 2024-08-13 ======================================================================================= Fixed ^^^^^ - fix: tables and cell output `#460 `_ Dependencies ^^^^^^^^^^^^ - ci: bump ansys/actions from 6 to 7 `#457 `_ - build(deps): bump numpydoc from 1.7.0 to 1.8.0 `#459 `_ `1.0.3 `_ - 2024-08-09 ======================================================================================= Fixed ^^^^^ - fix: minor style changes `#452 `_ - fix: downgrade the autoapi and keep ``autoapi`` toctree to ``True`` by default `#453 `_ - fix: `pygment_styles` with dark and light theme and dark theme table `#454 `_ `1.0.2 `_ - 2024-08-08 ======================================================================================= Changed ^^^^^^^ - maint: update ansys actions `#449 `_ Fixed ^^^^^ - fix: sphinx design image background `#450 `_ `1.0.1 `_ - 2024-08-08 ======================================================================================= Fixed ^^^^^ - fix: stable docs indexing package name `#446 `_ `1.0.0 `_ - 2024-08-08 ======================================================================================= Added ^^^^^ - fix: update the github icon `#401 `_ - feat: add default logo and update logo option with theme `#425 `_ - feat: add quarto cheat sheet extension with cheat sheet option `#428 `_ Changed ^^^^^^^ - chore: update CHANGELOG for v0.16.2 `#381 `_ - chore: update CHANGELOG for v0.16.3 `#389 `_ - chore: update CHANGELOG for v0.16.4 `#390 `_ - chore: update CHANGELOG for v0.16.5 `#394 `_ - chore: update CHANGELOG for v0.16.6 `#402 `_ Fixed ^^^^^ - fix: Align cheat sheet center `#382 `_ - fix: reformat the style files `#406 `_ - fix: reformat the table styles `#408 `_ - fix: reformat navigation bar and background `#409 `_ - fix: `primary` ,`secondary` sidebars and links `#411 `_ - fix: sphinx design reformat `#412 `_ - fix: update the breadcrumbs `#419 `_ - fix: admonitions style `#424 `_ - fix: sidebar borders and overflow `#427 `_ - fix: search bar styles `#429 `_ - fix: updated the logo options `#431 `_ - fix: add dropdown styles for the header navigation bar `#437 `_ - fix: dark theme variables `#438 `_ - fix: sphinx card `box shadow` on focus `#439 `_ - fix: focus links with keyboard `#440 `_ - fix: search bar style for dark theme, icons links `#442 `_ Dependencies ^^^^^^^^^^^^ - build(deps-dev): update pydata-sphinx-theme requirement from <0.15,>=0.14 to >=0.15 `#336 `_ - chore: version 0.17.dev0 `#386 `_ - chore(deps): bump requests from 2.32.2 to 2.32.3 `#391 `_ - docs: reformat the documentation `#396 `_ - chore(deps): bump sphinx-autoapi from 3.1.1 to 3.1.2 `#405 `_ - build(deps): bump pyvista[jupyter] from 0.43.10 to 0.44.0 `#413 `_ - build(deps): bump jupytext from 1.16.2 to 1.16.3 `#415 `_ - build(deps): bump sphinx from 7.3.7 to 7.4.4 `#416 `_ - build(deps): bump sphinx from 7.4.4 to 7.4.5 `#417 `_ - build(deps): bump sphinx from 7.4.5 to 7.4.6 `#418 `_ - build(deps): bump sphinx-autoapi from 3.1.2 to 3.2.0 `#420 `_ - build(deps): bump sphinx-gallery from 0.16.0 to 0.17.0 `#421 `_ - build(deps): bump pyvista[jupyter] from 0.44.0 to 0.44.1 `#422 `_ - build(deps): bump sphinx from 7.4.6 to 7.4.7 `#423 `_ - build(deps): bump sphinx-autoapi from 3.2.0 to 3.2.1 `#426 `_ - build(deps): bump sphinx-notfound-page from 1.0.2 to 1.0.3 `#432 `_ - build(deps): bump jupytext from 1.16.3 to 1.16.4 `#433 `_ - build(deps): bump sphinx-notfound-page from 1.0.3 to 1.0.4 `#434 `_ - build(deps): bump sphinx-design from 0.6.0 to 0.6.1 `#435 `_ - build(deps): bump sphinx from 7.4.7 to 8.0.2 `#436 `_ - build(deps): bump sphinx-gallery from 0.17.0 to 0.17.1 `#441 `_ Miscellaneous ^^^^^^^^^^^^^ - refactor: remove function duplicate `#407 `_ - docs: Update `mail id` in README.rst `#414 `_ `0.16.6 `_ - 2024-06-18 ========================================================================================= Fixed ^^^^^ - fix: wrong env var name for PACKAGE_NAME `#395 `_ `0.16.5 `_ - 2024-05-31 ========================================================================================= Fixed ^^^^^ - fix: sphinx design card font size `#393 `_ `0.16.4 `_ - 2024-05-29 ========================================================================================= Added ^^^^^ - feat: adapt package to general PyAnsys repository layout `#387 `_ Dependencies ^^^^^^^^^^^^ - chore(deps): bump sphinx-design from 0.5.0 to 0.6.0 `#383 `_ - chore(deps): bump sphinx-notfound-page from 1.0.1 to 1.0.2 `#384 `_ - chore(deps): bump sphinx-autoapi from 3.1.0 to 3.1.1 `#385 `_ `0.16.3 `_ - 2024-05-29 ========================================================================================= Fixed ^^^^^ - fix: update the sphinx design style to disable display of name `#388 `_ `0.16.2 `_ - 2024-05-22 ========================================================================================= Changed ^^^^^^^ - chore: update CHANGELOG for v0.16.1 `#379 `_ Miscellaneous ^^^^^^^^^^^^^ - docs: update changelog_template.jinja `#380 `_ `0.16.1 `_ - 2024-05-22 ========================================================================================= Added ^^^^^ - feat: add nerd fonts for ``autoapi`` templates icon `#362 `_ - feat: add the changelog action `#370 `_ - feat: add autoapi extension `#372 `_ Fixed ^^^^^ - fix: add changelog action in ci-cd `#378 `_ Dependencies ^^^^^^^^^^^^ - chore(deps): bump requests from 2.31.0 to 2.32.1 `#374 `_ - maint: update the sphinx-autoapi version `#375 `_ - chore(deps): bump sphinx-notfound-page from 1.0.0 to 1.0.1 `#376 `_ - chore(deps): bump requests from 2.32.1 to 2.32.2 `#377 `_ .. vale on