You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 2025R2/dpf-framework-25-r2/changelog/changelog.md
+6-23Lines changed: 6 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,11 @@
1
1
# Changelog
2
2
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.
Copy file name to clipboardExpand all lines: 2025R2/dpf-framework-25-r2/user-guide/dpf-docs-local-preview.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ This guide shows you how to create your own local copy of the DPF Framework docu
18
18
This step-by-step guide walks you through:
19
19
20
20
- 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.
22
22
- How to update the "Operator specifications" section of your documentation based on a custom DPF installation.
23
23
24
24
## About the command line
@@ -42,7 +42,8 @@ This guide uses the **command line** (also called terminal or PowerShell on Wind
42
42
Create a local website to view DPF Framework documentation in a user-friendly format (like a regular website with navigation and search).
43
43
The DPF Framework documentation includes both general reference material and the DPF operators documentation.
44
44
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
+
46
47
47
48
### Step 1: Install the website builder (DocFX)
48
49
@@ -150,7 +151,7 @@ Download and install the latest stable version of Python from the https://www.py
150
151
151
152
If you want to use older versions of Python, the minimum version supported by ansys-dpf-core is 3.10.
152
153
153
-
1.**Test your Python installation** by typing:
154
+
**Test your Python installation** by typing:
154
155
155
156
```powershell
156
157
python --version
@@ -217,19 +218,18 @@ You need to install the DPF server software. Select the installation method that
**What these do:** Configure DPF to work with your license and permissions. See [Licensing](../getting-started/licensing.md) section for more information.
227
228
228
-
### Step 4: Update the DPF operators documentation
229
+
### Step 3: Update the DPF operators documentation
229
230
230
231
Next, generate the DPF operators Markdown documentation files. Choose the option that fits your needs.
231
232
232
-
233
233
**Update the current documentation with the default DPF installation:**
234
234
235
235
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
278
278
dpf_generate_operators_doc.exe --include_private
279
279
```
280
280
281
-
#### Optional: Document composites operators
281
+
#### Optional: Document Composites operators
282
282
283
283
Generate the output files for all operators including operators of the ``Composites`` DPF plugin with the ``--include_composites`` command argument:
**What this does:** Creates documentation only for the specified plugin.
332
332
333
-
### Step 5: Rebuild the documentation
333
+
### Step 4: Rebuild the documentation
334
334
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.
0 commit comments