Skip to content

Conversation

seanpearsonuk
Copy link
Collaborator

No description provided.

.. _ref_user_guide_tui_api:

Using the TUI APIs
Using TUI Commands
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe rename the file tui_commands.rst

Copy link
Collaborator

@dnwillia-work dnwillia-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but still a few warnings in the doc build which probably prevent the CI from passing.

@seanpearsonuk
Copy link
Collaborator Author

Looks good but still a few warnings in the doc build which probably prevent the CI from passing.

Yes, that's right. Small issues are proving very problematic.

@@ -0,0 +1,23 @@
.. _ref_solver_tui_commands:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkundu1 what file name do you see locally for this file in this branch?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't fully understand the comment, but it is tui.rst.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkundu1 Sorry, I will clarify. The two files where I put this comment have had name changes - can't understand why it didn't change for you. After you pushed, I simply pulled and pushed again, and the names updated.

Copy link
Contributor

@mkundu1 mkundu1 Jul 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seanpearsonuk Sorry, apparently I forgot to do a fetch before checking out your branch, thus got an older version of it

@@ -1,30 +1,29 @@
.. _ref_user_guide_tui_api:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkundu1 what file name do you see locally for this file in this branch?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tui_api.rst

@seanpearsonuk
Copy link
Collaborator Author

seanpearsonuk commented Jul 1, 2022

@mkundu1 did you see any warnings? I get:

pyfluent\doc\source\api\core\solver\tuicommands.rst:17: WARNING: Failed to create a cross reference. A title or caption not found: ref_solver_tui
pyfluent\doc\source\index.rst:56: WARNING: Failed to create a cross reference. A title or caption not found: ref_solver_tui

EDIT: probably I need to run the tui gen again. I probably still have the local change in that generated API file.

I reran; it all looks good and no warnings at all. @mkundu1 huge thanks for your contribution here. If you approve, we could merge this.

@mkundu1 mkundu1 self-requested a review July 1, 2022 16:25
@seanpearsonuk seanpearsonuk merged commit d9e07fa into main Jul 1, 2022
@seanpearsonuk seanpearsonuk deleted the doc/user_guide_tuis branch July 1, 2022 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants