This PR reinstates a rule in the "sweep.yaml" file that was removed in a recent commit. The rule pertains to the documentation of Jupyter Notebook examples in the docs directory using sphinx-parsable documentation. This rule is crucial for maintaining the project's documentation standard.
Summary of Changes
Added the rule "All Jupyter Notebook examples should also be documented in the docs directory, using native, sphinx-parsable documentation." to the list of rules in the "sweep.yaml" file.
This change ensures that all Jupyter Notebook examples are documented in a manner that is compatible with Sphinx, thereby maintaining the project's documentation standard.
PR Feedback (click)
I created this PR to address this rule:
"All documentation should be sphinx-compatible."
Description
This PR reinstates a rule in the "sweep.yaml" file that was removed in a recent commit. The rule pertains to the documentation of Jupyter Notebook examples in the
docs
directory using sphinx-parsable documentation. This rule is crucial for maintaining the project's documentation standard.Summary of Changes
docs
directory, using native, sphinx-parsable documentation." to the list of rules in the "sweep.yaml" file.This change ensures that all Jupyter Notebook examples are documented in a manner that is compatible with Sphinx, thereby maintaining the project's documentation standard.