You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Scripts such as main.py that have python code outside of functions creates issues for many things such as documentation generation.
When you import a module all code is executed, so there is no way to import say main.py without all of the extra stuff happening.
The way around this is to wrap up all code that is not inside of a function into the main function.
At some point, it will need to be cleaned up so sphinx-doc can run correctly on all python files.
Currently the sphinx-apidoc has to exclude the following scripts in order for the docs to build correctly:
bootstrap.py
main.py
tasks.py
helpers.py
configs.py
The text was updated successfully, but these errors were encountered:
Scripts such as main.py that have python code outside of functions creates issues for many things such as documentation generation.
When you import a module all code is executed, so there is no way to import say main.py without all of the extra stuff happening.
The way around this is to wrap up all code that is not inside of a function into the main function.
At some point, it will need to be cleaned up so sphinx-doc can run correctly on all python files.
Currently the sphinx-apidoc has to exclude the following scripts in order for the docs to build correctly:
The text was updated successfully, but these errors were encountered: