Skip to content

Commit cbe619b

Browse files
clatapieclatapie
committed
release: bump the version to 0.2.1
2 parents 08ee1e6 + 9a126ac commit cbe619b

File tree

17 files changed

+283
-162
lines changed

17 files changed

+283
-162
lines changed

‎.github/workflows/autodoc_cicd.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
runs-on: ubuntu-latest
2525
steps:
2626
- name: "Install Git and checkout project"
27-
uses: actions/checkout@v3
27+
uses: actions/checkout@v4
2828

2929
- name: "Setup Python"
3030
uses: actions/setup-python@v4
@@ -41,7 +41,7 @@ jobs:
4141
4242
# The token will expire in 2024.
4343
- name: "Checkout mapdl-cmd-doc repository"
44-
uses: actions/checkout@v3
44+
uses: actions/checkout@v4
4545
with:
4646
repository: ansys-internal/mapdl-cmd-doc
4747
ref: feat/pyconverter-xml2py-predifined-format
@@ -133,3 +133,4 @@ jobs:
133133
python-version: ${{ inputs.MAIN_PYTHON_VERSION }}
134134
checkout: false
135135
sphinxopts: -j auto
136+
check-links: false

‎.github/workflows/ci_cd.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ jobs:
9696

9797
steps:
9898
- name: "Install Git and checkout project"
99-
uses: actions/checkout@v3
99+
uses: actions/checkout@v4
100100

101101
- name: "Setup Python"
102102
uses: actions/setup-python@v4
@@ -118,7 +118,7 @@ jobs:
118118
119119
# The token will expire in 2024.
120120
- name: "Checkout mapdl-cmd-doc repository"
121-
uses: actions/checkout@v3
121+
uses: actions/checkout@v4
122122
with:
123123
repository: ansys-internal/mapdl-cmd-doc
124124
ref: feat/pyconverter-xml2py-predifined-format
@@ -155,7 +155,7 @@ jobs:
155155
needs: [doc-style]
156156
steps:
157157
- name: "Install Git and checkout project"
158-
uses: actions/checkout@v3
158+
uses: actions/checkout@v4
159159

160160
- name: "Setup Python"
161161
uses: actions/setup-python@v4

‎.github/workflows/label.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
name: Syncer
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: actions/checkout@v3
20+
- uses: actions/checkout@v4
2121
- uses: micnncim/action-label-syncer@v1
2222
env:
2323
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎_package/pyproject.toml

+7-7
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,22 @@ dependencies = [
3434

3535
[project.optional-dependencies]
3636
doc = [
37-
"Sphinx==7.0.1",
37+
"Sphinx==7.2.5",
3838
"build>= 0.10.0",
3939
"jupyter_sphinx==0.4.0",
40-
"linuxdoc==20230629",
41-
"numpy==1.25.1",
40+
"linuxdoc==20230827",
41+
"numpy==1.25.2",
4242
"numpydoc==1.5.0",
43-
"pandas==2.0.3",
43+
"pandas==2.1.0",
4444
"parse==1.19.1",
4545
"pypandoc==1.11",
4646
"pytest-sphinx==0.5.0",
4747
"pydata_sphinx_theme==0.13.3",
4848
"sphinx-autobuild==2021.3.14",
49-
"sphinx-autodoc-typehints==1.23.3",
49+
"sphinx-autodoc-typehints==1.24.0",
5050
"sphinx-copybutton==0.5.2",
51-
"sphinx-notfound-page==0.8.3",
52-
"sphinx-gallery==0.13.0",
51+
"sphinx-notfound-page==1.0.0",
52+
"sphinx-gallery==0.14.0",
5353
]
5454

5555
[tool.flit.module]

‎doc/source/api/download.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Download
2+
========
3+
4+
.. currentmodule:: pyconverter.xml2py.download
5+
6+
The following functions enable to download the `_package` folder
7+
from the `GitHub repository <pyconverter.xml2py_gh_>`_.
8+
9+
.. autosummary::
10+
:toctree: _autosummary/writer
11+
12+
download
13+
download_folder
14+
download_template

‎doc/source/conf.py

+11
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,17 @@
136136
with open("links.rst") as f:
137137
rst_epilog += f.read()
138138

139+
linkcheck_ignore = [
140+
r"api/index.html",
141+
r"getting_started/index.html",
142+
r"contributing/index.html",
143+
r"user_guide/index.html",
144+
]
145+
146+
linkcheck_allowed_redirect = [
147+
r"https://tox.wiki/",
148+
]
149+
139150
# The name of the Pygments (syntax highlighting) style to use.
140151
pygments_style = "sphinx"
141152

‎doc/source/contributing/index.rst

+127-24
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,128 @@ with this guide before attempting to contribute to PyConverter-XML2Py.
1010

1111
The following contribution information is specific to PyConverter-XML2Py.
1212

13-
Clone the repository
14-
--------------------
13+
Developer installation
14+
----------------------
1515

16+
Follow these steps to install the package in developer mode:
1617

17-
Run this code to clone and install the latest version of PyConverter-XML2Py in development mode:
18+
#. Clone the repository:
1819

19-
.. code:: console
20+
.. code:: bash
21+
22+
git clone https://github.com/ansys/pyconverter-xml2py.git
23+
24+
#. Create a fresh-clean Python environment and activate it. If you require
25+
additional information on creation of a virtual environment, see the
26+
official Python `venv`_ documentation.
27+
28+
.. tab-set::
29+
30+
.. tab-item:: Linux
31+
:sync: linux
32+
33+
::
34+
35+
python -m venv .venv
36+
source .venv/bin/activate
37+
38+
.. tab-item:: macOS
39+
:sync: macos
40+
41+
::
42+
43+
python -m venv .venv
44+
source .venv/bin/activate
45+
46+
.. tab-item:: Windows
47+
:sync: windows
48+
49+
::
50+
51+
python -m venv .venv
52+
.\.venv\Scripts\activate
53+
54+
55+
#. Make sure you have the latest version of `pip`_:
56+
57+
.. code:: bash
58+
59+
python -m pip install -U pip
60+
61+
#. Install the project in editable mode:
62+
63+
.. code:: bash
64+
65+
python -m pip install -e .
66+
67+
#. Install additional requirements (if needed):
68+
69+
.. code:: bash
70+
71+
python -m pip install .[doc,tests]
2072
21-
git clone https://github.com/ansys/pyconverter-xml2py
22-
cd pyconverter-xml2py
23-
python -m pip install --upgrade pip
24-
pip install -e .
73+
#. Verify your development installation:
2574

26-
Post issues
27-
-----------
75+
.. code:: bash
2876
29-
Use the `PyConverter-XML2Py Issues <pyconverter.xml2py_issues_>`_ page to submit questions,
30-
report bugs, and request new features. When possible, use these issue
31-
templates:
77+
pytest tests -v
3278
33-
* Bug report template
34-
* Feature request template
3579
36-
If your issue does not fit into one of these categories, create your own issue.
80+
Style and testing
81+
-----------------
3782

38-
To reach the PyAnsys support team, email `[email protected] <[email protected]>`_.
83+
If required, you can call style commands (such as `black`_, `isort`_,
84+
and `flake8`_) or unit testing commands (such as `pytest`_) from the command line.
85+
However, this does not guarantee that your project is being tested in an isolated
86+
environment, which is why you might consider using `tox`_.
3987

4088

89+
Documentation
90+
-------------
4191

42-
Build documentation
43-
-------------------
92+
For building documentation, you can run the usual rules provided in the
93+
`Sphinx`_ Makefile or make.bat:
4494

45-
To build the PyConverter-XML2Py documentation locally, in the root directory of the repository,
46-
run these commands::
47-
48-
pip install .[doc]
49-
.\doc\make.bat html
95+
.. tab-set::
96+
97+
.. tab-item:: Makefile
98+
99+
::
100+
101+
python -m pip install .[doc]
102+
make -C doc html
103+
104+
105+
.. tab-item:: make.bat
106+
107+
::
108+
109+
python -m pip install .[doc]
110+
.\doc\make.bat html
111+
112+
Once the documentation is built, you can open it as follows.
113+
114+
.. tab-set::
115+
116+
.. tab-item:: Linux
117+
:sync: linux
118+
119+
By running the command:
120+
::
121+
122+
your_browser_name doc/html/index.html
123+
124+
.. tab-item:: macOS
125+
:sync: macos
126+
127+
By opening the documentation, which you do by going to the ``doc/html`` directory
128+
and opening the ``index.html`` file.
129+
130+
.. tab-item:: Windows
131+
:sync: windows
132+
133+
By opening the documentation, which you do by going to the ``doc/html`` directory
134+
and opening the ``index.html`` file.
50135

51136

52137
Adhere to code style
@@ -83,3 +168,21 @@ This way, it's not possible for you to push code that fails the style checks
83168
check for merge conflicts................................................Passed
84169
debug statements (python)................................................Passed
85170
Validate GitHub Workflows................................................Passed
171+
172+
173+
Distributing
174+
------------
175+
176+
If you would like to create either source or wheel files, start by installing
177+
the building requirements:
178+
179+
.. code:: bash
180+
181+
python -m pip install -e .[doc,tests]
182+
183+
Then, execute these commands:
184+
185+
.. code:: bash
186+
187+
python -m build
188+
python -m twine check dist/*

0 commit comments

Comments
 (0)