documenteer.conf.extend_excludes_for_non_index_source(exclude_patterns, extension, working_dir=None)

Extend the exclude_patterns configuration to include files with a specific extension that aren’t the index file.

This is useful for technotes where only the index{.ext} file is valid as a source file.

  • exclude_patterns (list[str]) – The Sphinx configuration, exclude_patterns. This configuration is modified in place.

  • extension (str) – The file extension to exclude. Examples: "ipynb", "md", "rst". The extension does not include the leading period.

  • working_dir (Path | None, default: None) – The working directory to search for files. If not provided, the current working directory is used. This should be equivalent to the directory where the Sphinx configuration is located.

Return type: