Release notes#

This document contains the release notes for the project.

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