release: bump the version to 0.2.1

Author: clatapie

.github/workflows/autodoc_cicd.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Install Git and checkout project"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Setup Python"
         uses: actions/setup-python@v4
@@ -41,7 +41,7 @@ jobs:
       
       # The token will expire in 2024.
       - name: "Checkout mapdl-cmd-doc repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: ansys-internal/mapdl-cmd-doc
           ref: feat/pyconverter-xml2py-predifined-format
@@ -133,3 +133,4 @@ jobs:
           python-version: ${{ inputs.MAIN_PYTHON_VERSION }}
           checkout: false
           sphinxopts: -j auto
+          check-links: false

.github/workflows/ci_cd.yml

@@ -96,7 +96,7 @@ jobs:
 
     steps:
       - name: "Install Git and checkout project"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Setup Python"
         uses: actions/setup-python@v4
@@ -118,7 +118,7 @@ jobs:
     
       # The token will expire in 2024.
       - name: "Checkout mapdl-cmd-doc repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: ansys-internal/mapdl-cmd-doc
           ref: feat/pyconverter-xml2py-predifined-format
@@ -155,7 +155,7 @@ jobs:
     needs: [doc-style]
     steps:
       - name: "Install Git and checkout project"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Setup Python"
         uses: actions/setup-python@v4

.github/workflows/label.yml

@@ -17,7 +17,7 @@ jobs:
     name: Syncer
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: micnncim/action-label-syncer@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

_package/pyproject.toml

@@ -34,22 +34,22 @@ dependencies = [
 
 [project.optional-dependencies]
 doc = [
-    "Sphinx==7.0.1",
+    "Sphinx==7.2.5",
     "build>= 0.10.0",
     "jupyter_sphinx==0.4.0",
-    "linuxdoc==20230629",
-    "numpy==1.25.1",
+    "linuxdoc==20230827",
+    "numpy==1.25.2",
     "numpydoc==1.5.0",
-    "pandas==2.0.3",
+    "pandas==2.1.0",
     "parse==1.19.1",
     "pypandoc==1.11",
     "pytest-sphinx==0.5.0",
     "pydata_sphinx_theme==0.13.3",
     "sphinx-autobuild==2021.3.14",
-    "sphinx-autodoc-typehints==1.23.3",
+    "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
-    "sphinx-notfound-page==0.8.3",
-    "sphinx-gallery==0.13.0",
+    "sphinx-notfound-page==1.0.0",
+    "sphinx-gallery==0.14.0",
 ]
 
 [tool.flit.module]

doc/source/api/download.rst

@@ -0,0 +1,14 @@
+Download
+========
+
+.. currentmodule:: pyconverter.xml2py.download
+
+The following functions enable to download the `_package` folder
+from the `GitHub repository <pyconverter.xml2py_gh_>`_.
+
+.. autosummary::
+   :toctree: _autosummary/writer
+
+   download
+   download_folder
+   download_template

doc/source/conf.py

@@ -136,6 +136,17 @@
 with open("links.rst") as f:
     rst_epilog += f.read()
 
+linkcheck_ignore = [
+    r"api/index.html",
+    r"getting_started/index.html",
+    r"contributing/index.html",
+    r"user_guide/index.html",
+]
+
+linkcheck_allowed_redirect = [
+    r"https://tox.wiki/",
+]
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 

doc/source/contributing/index.rst

@@ -10,43 +10,128 @@ with this guide before attempting to contribute to PyConverter-XML2Py.
 
 The following contribution information is specific to PyConverter-XML2Py.
 
-Clone the repository
---------------------
+Developer installation
+----------------------
 
+Follow these steps to install the package in developer mode:
 
-Run this code to clone and install the latest version of PyConverter-XML2Py in development mode:
+#. Clone the repository:
 
-.. code:: console
+    .. code:: bash
+
+        git clone https://github.com/ansys/pyconverter-xml2py.git
+
+#. Create a fresh-clean Python environment and activate it. If you require
+   additional information on creation of a virtual environment, see the
+   official Python `venv`_ documentation.
+
+    .. tab-set::
+
+      .. tab-item:: Linux
+        :sync: linux
+
+        ::
+
+          python -m venv .venv
+          source .venv/bin/activate
+
+      .. tab-item:: macOS
+        :sync: macos
+
+        ::
+
+          python -m venv .venv
+          source .venv/bin/activate
+
+      .. tab-item:: Windows
+        :sync: windows
+
+        ::
+
+          python -m venv .venv
+          .\.venv\Scripts\activate
+
+
+#. Make sure you have the latest version of `pip`_:
+
+    .. code:: bash
+
+        python -m pip install -U pip
+
+#. Install the project in editable mode:
+
+    .. code:: bash
+
+        python -m pip install -e .
+
+#. Install additional requirements (if needed):
+
+     .. code:: bash
+
+        python -m pip install .[doc,tests]
 
-    git clone https://github.com/ansys/pyconverter-xml2py
-    cd pyconverter-xml2py
-    python -m pip install --upgrade pip
-    pip install -e .
+#. Verify your development installation:
 
-Post issues
------------
+    .. code:: bash
 
-Use the `PyConverter-XML2Py Issues <pyconverter.xml2py_issues_>`_ page to submit questions,
-report bugs, and request new features. When possible, use these issue
-templates:
+        pytest tests -v
 
-* Bug report template
-* Feature request template
 
-If your issue does not fit into one of these categories, create your own issue.
+Style and testing
+-----------------
 
-To reach the PyAnsys support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+If required, you can call style commands (such as `black`_, `isort`_,
+and `flake8`_) or unit testing commands (such as `pytest`_) from the command line.
+However, this does not guarantee that your project is being tested in an isolated
+environment, which is why you might consider using `tox`_.
 
 
+Documentation
+-------------
 
-Build documentation
--------------------
+For building documentation, you can run the usual rules provided in the
+`Sphinx`_ Makefile or make.bat:
 
-To build the PyConverter-XML2Py documentation locally, in the root directory of the repository,
-run these commands::
-    
-    pip install .[doc]
-    .\doc\make.bat html 
+.. tab-set::
+
+  .. tab-item:: Makefile
+
+    ::
+
+      python -m pip install .[doc]
+      make -C doc html
+
+
+  .. tab-item:: make.bat
+
+    ::
+
+      python -m pip install .[doc]
+      .\doc\make.bat html
+
+Once the documentation is built, you can open it as follows.
+
+.. tab-set::
+
+  .. tab-item:: Linux
+      :sync: linux
+
+      By running the command: 
+      ::
+
+        your_browser_name doc/html/index.html
+
+  .. tab-item:: macOS
+      :sync: macos
+
+      By opening the documentation, which you do by going to the ``doc/html`` directory
+      and opening the ``index.html`` file.
+
+  .. tab-item:: Windows
+      :sync: windows
+
+      By opening the documentation, which you do by going to the ``doc/html`` directory
+      and opening the ``index.html`` file.
 
 
 Adhere to code style
@@ -83,3 +168,21 @@ This way, it's not possible for you to push code that fails the style checks
   check for merge conflicts................................................Passed
   debug statements (python)................................................Passed
   Validate GitHub Workflows................................................Passed
+
+
+Distributing
+------------
+
+If you would like to create either source or wheel files, start by installing
+the building requirements:
+
+.. code:: bash
+
+    python -m pip install -e .[doc,tests]
+
+Then, execute these commands:
+
+    .. code:: bash
+
+        python -m build
+        python -m twine check dist/*