-
Notifications
You must be signed in to change notification settings - Fork 56
update doc regarding tui #576
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
* Expand the root section of settings.rst. * Fix doc build * Add doc paths in API code cache
…uent into doc/user_guide_tuis
.. _ref_user_guide_tui_api: | ||
|
||
Using the TUI APIs | ||
Using TUI Commands |
There was a problem hiding this comment.
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
There was a problem hiding this 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.
Yes, that's right. Small issues are proving very problematic. |
…uent into doc/user_guide_tuis
@@ -0,0 +1,23 @@ | |||
.. _ref_solver_tui_commands: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
doc/source/user_guide/tui_api.rst
Outdated
@@ -1,30 +1,29 @@ | |||
.. _ref_user_guide_tui_api: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tui_api.rst
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. |
No description provided.