fix: suppress autosectionlabel warning for changelog file (#487)

* fix: update the autosection * fix: update the extension * fix: update changelog * fix: supress warning * Adding changelog entry: 487.fixed.md * Adding changelog entry: 487.fixed.md * docs: revert chnages --------- Co-authored-by: pyansys-ci-bot <[email protected]>
ansys · Jun 4, 2024 · dd664a8 · dd664a8
1 parent 6fe19fd
commit dd664a8
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 10 deletions.
diff --git a/doc/changelog.d/487.fixed.md b/doc/changelog.d/487.fixed.md
@@ -0,0 +1 @@
+fix: suppress ``autosectionlabel`` warning for ``changelog`` file
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -9,6 +9,44 @@ This document contains the release notes for the project.
 
 .. towncrier release notes start
 
+`3.0.0 <https://github.com/ansys/ansys-templates/releases/tag/v3.0.0>`_ - 2024-06-04
+====================================================================================
+
+Added
+^^^^^
+
+- feat: update CLI option for creating a Dash UI using AWC as well `#477 <https://github.com/ansys/ansys-templates/pull/477>`_
+
+
+Changed
+^^^^^^^
+
+- chore: update CHANGELOG for v2.1.0 `#473 <https://github.com/ansys/ansys-templates/pull/473>`_
+- maint: bump main dev version `#474 <https://github.com/ansys/ansys-templates/pull/474>`_
+- Maintenance/update solution template `#484 <https://github.com/ansys/ansys-templates/pull/484>`_
+
+
+Fixed
+^^^^^
+
+- fix: update pydocstyle in ``pyproject.toml`` file `#478 <https://github.com/ansys/ansys-templates/pull/478>`_
+- fix: run tests with specified python-version in CI `#480 <https://github.com/ansys/ansys-templates/pull/480>`_
+- fix: change socio-economic to socioeconomic for codespell v2.3.0 `#485 <https://github.com/ansys/ansys-templates/pull/485>`_
+
+
+Dependencies
+^^^^^^^^^^^^
+
+- Build(deps): Bump ansys-sphinx-theme from 0.14.1 to 0.16.0 `#475 <https://github.com/ansys/ansys-templates/pull/475>`_
+
+
+Miscellaneous
+^^^^^^^^^^^^^
+
+- Update ansys saf portal version `#472 <https://github.com/ansys/ansys-templates/pull/472>`_
+- feat: Add devcontainer config for codespaces `#481 <https://github.com/ansys/ansys-templates/pull/481>`_
+- docs: update authors file `#482 <https://github.com/ansys/ansys-templates/pull/482>`_
+
 `2.1.0 <https://github.com/ansys/ansys-templates/releases/tag/v2.1.0>`_ - 2024-05-14
 ====================================================================================
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -65,12 +65,14 @@
 extensions = [
     "numpydoc",
     "sphinx.ext.autodoc",
-    "sphinx.ext.autosectionlabel",
     "sphinx.ext.autosummary",
+    "sphinx.ext.autosectionlabel",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
 ]
 
+suppress_warnings = ["autosectionlabel.changelog"]
+
 # Intersphinx mapping
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

diff --git a/doc/source/templates.rst b/doc/source/templates.rst
@@ -80,7 +80,6 @@ To create a new project using this template by running:
 
     `ansys-templates/demo - doc-project <https://github.com/ansys/ansys-templates/tree/demo/doc-project>`_
 
-
 pybasic
 -------
 This template renders to a basic Python project. It does not follow the Ansys
@@ -105,7 +104,6 @@ To create a new project using this template by running:
 
     `ansys-templates/demo - pybasic <https://github.com/ansys/ansys-templates/tree/demo/pybasic>`_
 
-
 pyansys
 -------
 This template renders to a basic Python project compliant with the latest
@@ -130,7 +128,6 @@ To create a new project using this template, run:
 
     `ansys-templates/demo - pyansys <https://github.com/ansys/ansys-templates/tree/demo/pyansys>`_
 
-
 pyansys-advanced
 ----------------
 This template renders to a basic Python project compliant with the latest
@@ -160,7 +157,6 @@ To create a new project using this template, run:
     * `ansys-templates/demo - pyansys-advanced-poetry <https://github.com/ansys/ansys-templates/tree/demo/pyansys-advanced-poetry>`_
     * `ansys-templates/demo - pyansys-advanced-setuptools <https://github.com/ansys/ansys-templates/tree/demo/pyansys-advanced-setuptools>`_
 
-
 pyansys-openapi-client
 ----------------------
 Create an OpenAPI Client Package project compliant with PyAnsys guidelines.
@@ -181,7 +177,6 @@ To create a new project using this template, run:
 
     Demo unavailable at the moment.
 
-
 pyace
 -----
 This template renders to a basic Python project compliant with the latest
@@ -208,7 +203,6 @@ To create a new project using this template, run:
 
     `ansys-templates/demo - pyace-pkg <https://github.com/ansys/ansys-templates/tree/demo/pyace-pkg>`_
 
-
 pyace-fast
 ----------
 This template renders to a basic Python project compliant with the latest
@@ -235,7 +229,6 @@ To create a new project using this template, run:
 
     `ansys-templates/demo - pyace-fast <https://github.com/ansys/ansys-templates/tree/demo/pyace-fast>`_
 
-
 pyace-flask
 -----------
 This template renders to a basic Python project compliant with the latest
@@ -263,7 +256,6 @@ To create a new project using this template, run:
 
     `ansys-templates/demo - pyace-flask <https://github.com/ansys/ansys-templates/tree/demo/pyace-flask>`_
 
-
 pyace-grpc
 ----------
 This template renders to a basic Python project compliant with the latest

diff --git a/pyproject.toml b/pyproject.toml
@@ -66,7 +66,7 @@ tests = [
 doc = [
     "ansys-sphinx-theme==0.16.0",
     "numpydoc==1.6.0",
-    "sphinx==7.2.6",
+    "sphinx==7.3.7",
     "sphinx-copybutton==0.5.2",
 ]