modified DPF doc generation in DPF Framework doc #230
Conversation
|
@ansys-akarcher did you try it out locally? |
| $env:ANSYSLMD_LICENSE_FILE = "1055@lyolmserv1.win.ansys.com" | ||
| ``` | ||
|
|
||
| ### 2. Install the DPF server |
There was a problem hiding this comment.
You also have to install ansys-dpf-core and jinja2
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
2025R2/dpf-framework-25-r2/getting-started/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,188 @@ | |||
| # DPF documentation: Generation and local preview | |||
|
|
|||
| This section details how to: | |||
There was a problem hiding this comment.
Add when this guide is useful (custom install, custom plugins/operators, to preview doc for a dev version)
|
@PProfizi |
There was a problem hiding this comment.
Several small comments, but a big proposition to change the source and target of copied files.
The idea would be to update the DevRelDocs repository files instead of what is proposed now.
A notable advantage would be that the Edit this page link on every page would work and redirect to the right file on the DevRelDocs GH project.
This would also be better as in the future we will not need to clone PyDPF-Core, but we will still need to clone DevRelDocs.
|
|
||
| This step prepares your computer with the necessary software and files. | ||
|
|
||
| #### Download the pydpf-core |
There was a problem hiding this comment.
| #### Download the pydpf-core | |
| #### Download the pydpf-core project |
2025R2/dpf-framework-25-r2/user-guide/dpf-docs-local-preview.md
Outdated
Show resolved
Hide resolved
| 1. Navigate to `pydpf-core/doc/source/operators-doc/` | ||
| 2. Copy all contents to your website's `docs` folder | ||
|
|
||
| ### Step 4: Add complete DPF Framework documentation |
There was a problem hiding this comment.
You can move the whole operator doc generation after this step, this way it is the generation script which overrides the DPF framework documentation, no?
There was a problem hiding this comment.
Also, it would be much better to copy-paste to the DevRelDocs repository as we then have the option to directly edit the page in GH:
There was a problem hiding this comment.
This tries to send you directly to the file on GH, which is very nice!
But you need to be within the git repository of interest.
There was a problem hiding this comment.
I tested copying the docfx.json file generated by docfx in MyDPFDocs into the DevRelDocs repository and generated the website. The documentation is properly generated and the Edit this page link works.
| 2. **Copy the documentation carefully:** | ||
| - **Important:** Do NOT copy the `operator-specifications` folder from the source, as this would overwrite your custom DPF operators documentation. | ||
| - Select all other files and folders from the source (excluding `operator-specifications`). | ||
| - Copy and paste them into your website's `docs` folder. |
There was a problem hiding this comment.
It asks whether to replace the toc.yml. Yes or No?
There was a problem hiding this comment.
The operator-specifications/operator-specifications.md file must actually be copied.
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
This page provides guidance for developers on how to generate DPF documentation locally and preview it. The generation steps still need to be updated, as they are currently based on my setup, which differs from the external development environment.