The docs/scripts/gen_ref_pages.py script should not be directly configured in the docs directory. Because MKDocs creates web pages for all content in the docs directory by default, and the mkdocs-jupyter plugin recognizes and converts it into a notebook page.
This results in the gen_ref_pages.py script content being inappropriately displayed in the official documentation.
I believe displaying this script in the official documentation is not the intended outcome. After PR fixes the build results will not contain the contents of the scripts directory.
Remarks
PR introduces (a) breaking change(s): <yes/no>
no
PR introduces (a) deprecation(s): <yes/no>
no
Purpose
The
docs/scripts/gen_ref_pages.pyscript should not be directly configured in the docs directory. Because MKDocs creates web pages for all content in the docs directory by default, and the mkdocs-jupyter plugin recognizes and converts it into a notebook page. This results in the gen_ref_pages.py script content being inappropriately displayed in the official documentation.We can currently view the script converted into a web page by manually accessing the following link: https://streampipes.apache.org/docs/docs/python/latest/scripts/gen_ref_pages/ Additionally, this page is not indexed in the navigation bar and can only be accessed by manually entering the link.
I believe displaying this script in the official documentation is not the intended outcome. After PR fixes the build results will not contain the contents of the scripts directory.
Remarks
PR introduces (a) breaking change(s): <yes/no> no PR introduces (a) deprecation(s): <yes/no> no