Skip to content

Commit 2592d2b

Browse files
authored
Merge pull request #251 from ansys/DPF-Framework-transfer-changes-on-26r1-to-25r2
DPF Framework 25r2- transfer the changes made on 26r1 to 25r2
2 parents 0485d28 + d8ccd3f commit 2592d2b

File tree

4 files changed

+374
-34
lines changed

4 files changed

+374
-34
lines changed

2025R2/dpf-framework-25-r2/changelog/changelog-25-r2.md renamed to 2025R2/dpf-framework-25-r2/changelog/changelog.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
11
# Changelog
22

3-
This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements. The following table shows which components have updates in each category.
4-
5-
| Component | Features | Changes | Fixes | Performance |
6-
|-----------|----------|---------|-------|-------------|
7-
| Framework |[15 items](#features_framework) |[4 items](#changes_framework) |[33 items](#fixes_framework) |[9 items](#performance_framework) |
8-
| HGP |[4 items](#features_hgp) |[1 item](#changes_hgp) |[6 items](#fixes_hgp) |[2 items](#performance_hgp) |
9-
| MAPDL |[11 items](#features_mapdl) |[3 items](#changes_mapdl) |[29 items](#fixes_mapdl) |[3 items](#performance_mapdl) |
10-
| LSDYNA |[2 items](#features_lsdyna) |[2 items](#changes_lsdyna) |[8 items](#fixes_lsdyna) ||
11-
| Math |[1 item](#features_math) |[2 items](#changes_math) |[1 item](#fixes_math) ||
12-
| HDF5 |[3 items](#features_hdf5) |[1 item](#changes_hdf5) |[8 items](#fixes_hdf5) ||
13-
| CFF ||[1 item](#changes_cff) |[2 items](#fixes_cff) ||
14-
| Compression |[1 item](#features_compression) |||[1 item](#performance_compression) |
15-
| Documentation |[1 item](#features_documentation) ||||
16-
| Motion |[1 item](#features_motion) ||||
17-
| CGNS |[1 item](#features_cgns) ||||
18-
| Engineering Data ||[1 item](#changes_engineering_data) |||
19-
| VTK |||[1 item](#fixes_vtk) ||
20-
21-
**Legend:**
22-
23-
- ✅ = Updates available in this category
24-
- ❌ = No updates in this category
25-
- Numbers in brackets indicate the count of items in each section
3+
This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements.
264

275
## Table of contents
6+
287
### Features categories
8+
299
* [Framework](#features_framework)
3010
* [HGP](#features_hgp)
3111
* [MAPDL](#features_mapdl)
@@ -38,6 +18,7 @@ This changelog is organized by category, with sections for new features, changes
3818
* [CGNS](#features_cgns)
3919

4020
### Changes categories
21+
4122
* [Framework](#changes_framework)
4223
* [HGP](#changes_hgp)
4324
* [MAPDL](#changes_mapdl)
@@ -48,6 +29,7 @@ This changelog is organized by category, with sections for new features, changes
4829
* [Engineering Data](#changes_engineering_data)
4930

5031
### Fixes categories
32+
5133
* [Framework](#fixes_framework)
5234
* [HGP](#fixes_hgp)
5335
* [MAPDL](#fixes_mapdl)
@@ -58,6 +40,7 @@ This changelog is organized by category, with sections for new features, changes
5840
* [VTK](#fixes_vtk)
5941

6042
### Performance improvements categories
43+
6144
* [Framework](#performance_framework)
6245
* [HGP](#performance_hgp)
6346
* [MAPDL](#performance_mapdl)

2025R2/dpf-framework-25-r2/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1809,4 +1809,4 @@
18091809
- name: weighted merge fields by label
18101810
href: operator-specifications/utility/weighted_merge_fields_by_label.md
18111811
- name: Changelog
1812-
href: changelog/changelog-25-r2.md
1812+
href: changelog/changelog.md

2025R2/dpf-framework-25-r2/user-guide/dpf-docs-local-preview.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This guide shows you how to create your own local copy of the DPF Framework docu
1818
This step-by-step guide walks you through:
1919

2020
- How to use basic command-line tools.
21-
- How to create a local website to view your custom documentation.
21+
- How to create a local website to view your DPF Framework HTML documentation.
2222
- How to update the "Operator specifications" section of your documentation based on a custom DPF installation.
2323

2424
## About the command line
@@ -42,7 +42,8 @@ This guide uses the **command line** (also called terminal or PowerShell on Wind
4242
Create a local website to view DPF Framework documentation in a user-friendly format (like a regular website with navigation and search).
4343
The DPF Framework documentation includes both general reference material and the DPF operators documentation.
4444

45-
You first get the sources for the official documentation at https://github.com/ansys/DevRelDocs, then update them locally, and generate a local website.
45+
First, install the DocFX website builder. Next, clone the official documentation source from [github.com/ansys/DevRelDocs](https://github.com/ansys/DevRelDocs). Use DocFX to generate a local version of the website.
46+
4647

4748
### Step 1: Install the website builder (DocFX)
4849

@@ -150,7 +151,7 @@ Download and install the latest stable version of Python from the https://www.py
150151

151152
If you want to use older versions of Python, the minimum version supported by ansys-dpf-core is 3.10.
152153

153-
1. **Test your Python installation** by typing:
154+
**Test your Python installation** by typing:
154155

155156
```powershell
156157
python --version
@@ -217,19 +218,18 @@ You need to install the DPF server software. Select the installation method that
217218
$env:ANSYS_DPF_ACCEPT_LA = "Y"
218219
```
219220

220-
1. **Set your license server** by typing:
221+
2. **Set your license server** by typing:
221222

222223
```powershell
223224
$env:ANSYSLMD_LICENSE_FILE = "1055@your-license-address"
224225
```
225226

226227
**What these do:** Configure DPF to work with your license and permissions. See [Licensing](../getting-started/licensing.md) section for more information.
227228

228-
### Step 4: Update the DPF operators documentation
229+
### Step 3: Update the DPF operators documentation
229230

230231
Next, generate the DPF operators Markdown documentation files. Choose the option that fits your needs.
231232

232-
233233
**Update the current documentation with the default DPF installation:**
234234

235235
Move to the root folder of the ``dpf-framework`` documentation downloaded in section ``Create your DPF Framework HTML documentation``, step ``Get the DPF Framework documentation source files``.
@@ -278,7 +278,7 @@ Generate the output files for all operators including private operators with the
278278
dpf_generate_operators_doc.exe --include_private
279279
```
280280

281-
#### Optional: Document composites operators
281+
#### Optional: Document Composites operators
282282

283283
Generate the output files for all operators including operators of the ``Composites`` DPF plugin with the ``--include_composites`` command argument:
284284

@@ -289,7 +289,7 @@ dpf_generate_operators_doc.exe --include_composites
289289
This is useful for installations where the ``Composites`` plugin is present but not loaded by default.
290290
This tells the script to try and load the plugin when starting DPF.
291291

292-
#### Optional: Document composites operators
292+
#### Optional: Document Sound operators
293293

294294
Generate the output files for all operators including operators of the ``Sound`` DPF plugin with the ``--include_sound`` command argument:
295295

@@ -330,9 +330,9 @@ dpf_generate_operators_doc.exe --plugin "mesh"
330330

331331
**What this does:** Creates documentation only for the specified plugin.
332332

333-
### Step 5: Rebuild the documentation
333+
### Step 4: Rebuild the documentation
334334

335-
Refer to the previous main section "Create your DPF Framework HTML documentation" and "Step 3: Generate a local website" to update the HTML documentation with the new content for DPF operators.
335+
Refer to the previous main section [Create your DPF Framework HTML documentation](#create-your-dpf-framework-html-documentation) and **Step 3: Generate a local website** to update the HTML documentation with the new content for DPF operators.
336336

337337
## Troubleshooting
338338

0 commit comments

Comments
 (0)