-
Notifications
You must be signed in to change notification settings - Fork 250
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
[Docs] Add python processing locally #12009
Conversation
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.
Some comments :)
Co-authored-by: Philipp Bucher <[email protected]>
Co-authored-by: Philipp Bucher <[email protected]>
@@ -258,6 +318,10 @@ def CreateNavigatonBar(root_path: str, max_levels: int, default_header_dict: dic | |||
file_output.write("entries:\n") | |||
file_output.writelines(list_of_strings) | |||
|
|||
if is_locally_built: | |||
from KratosMultiphysics.testing.utilities import GetPython3Command |
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.
from KratosMultiphysics.testing.utilities import GetPython3Command |
unused
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.
It is used within the method following this line, I did the import their so, specially in the CI, you don't need to have Kratos environment to depoly the pages.
Co-authored-by: Philipp Bucher <[email protected]>
Co-authored-by: Philipp Bucher <[email protected]>
Fixed the pushing of cpp outputs by adding "-u" arg. @philbucher could you check it ? Thanks :) |
This PR adds capability to add python snippet output to the docs automatically. Following is the documentation on how to use it.
## POST_PROCESS_PAGES_PYTHON_OUTPUT_GENERATION
anywhere in the python snippet. It should not have any leading or trailing spaces/tabs.## POST_PROCESS_PAGES_PYTHON_OUTPUT_GENERATION
tag line from the python snippet.This generation is only done if
process_pages.py
is passed with-t local
flag.** This will not change any existing python snippets. If the automated output is required, the above tag needs to be placed within the python snippet. **
🆕 Changelog