Doc/edits based on rendered doc #715
Conversation
|
I'm very confused by the organization of the "API reference" section. There's too may levels in the hierarchy, which may be a remnant from when the PyFluent-Visualization and PyFluent-Parametric libraries were once part of this library--or possibly because more APIs are yet to come. Also, for the TUI commands, rendered topics don't seem to be coming from files in the repo. I searched for rendered text to make edits and found no matches. Where is the content coming from and can I edit the source files? |
|
@PipKat: I have added @ajain-work as a reviewer here, as there are several changes/comments related to his work. I have added some comments already for some of them, but I would like @ajain-work to go through and verify the changes/comments. N.b. India are out today (15/08) due to a national holiday there. |
Hi Kathy, for the TUI and Settings APIs the API Python files and documentation are autogenerated by the modules implemented in the codegen area. You can build these locally by running the all a allapigen.py. The TUI API function documentation is extracted directly from the Fluent user documentation. Editing this would require updates to the Fluent documentation, you could talk with Stephen Fuqua about it. |
PipKat
force-pushed
the
doc/edits_based_on_rendered_doc
branch
from
50e4baa to
31855b8
Compare
PipKat
force-pushed
the
doc/edits_based_on_rendered_doc
branch
from
1582ac4 to
26e94a6
Compare
|
@ajain-work I think I must have your help to get the Build and Unit Testing check for v23.10 running again. (I think I changed an error message that might have caused this failure.) Also, I'm not sure why the v22.2 check is cancelled. |
|
@ajain-work All checks have passed. Now we just need to have you edit some of the existing content to ensure that someone new to PyFluent finds full and clear explanations. Thanks! |
|
So odd. @ajain-work This check passed after I last pulled in changes from main. I updated this request again today and now the failure is back. Can you please go through Sean's and Dan's comments and determine how we can get this PR merged. Thanks! |
Fix typo. Co-authored-by: Dan Williams <dan.williams@ansys.com>
Commit some suggestions from review.
Incorporate Sean's review comments
PipKat
force-pushed
the
doc/edits_based_on_rendered_doc
branch
from
3df2659 to
37b4da3
Compare
|
@dnwillia-work, @ajain-work, @jorgepiloto I would really like another approver on this PR, so that I can finally close it. If I don't receive any feedback on the open comments, I will assume that they will be addressed as further changes occur to this repo. |
|
@PipKat your PR is ready to merge |
Fixed capitalization error
|
@dnwillia-work, @ajain-work, @jorgepiloto Thanks for your approvals on this PR. |
6 participants
No description provided.