doc: update state marker

Author: LouisTsai-Csie

docs/templates/base.md.j2

@@ -11,6 +11,8 @@ Documentation for [`{{ pytest_node_id }}@{{ short_git_ref }}`]({{ source_code_ur
     ```console
 {% if is_benchmark %}
     fill -v {{ pytest_node_id }} -m benchmark
+{% elif is_state %}
+    fill -v {{ pytest_node_id }} -m state
 {% else %}
     fill -v {{ pytest_node_id }} --fork {{ target_or_valid_fork }}
 {% endif %}

src/pytest_plugins/filler/gen_test_doc/gen_test_doc.py

@@ -431,6 +431,7 @@ def create_function_page_props(self, test_functions: Dict["str", List[Item]]) ->
             )
 
             is_benchmark = items[0].get_closest_marker("benchmark") is not None
+            is_state = items[0].get_closest_marker("state") is not None
 
             self.function_page_props[function_id] = FunctionPageProps(
                 title=get_test_function_name(items[0]),
@@ -447,6 +448,7 @@ def create_function_page_props(self, test_functions: Dict["str", List[Item]]) ->
                 html_static_page_target=f"./{get_test_function_name(items[0])}.html",
                 mkdocs_function_page_target=f"./{get_test_function_name(items[0])}/",
                 is_benchmark=is_benchmark,
+                is_state=is_state,
             )
 
     def create_module_page_props(self) -> None:
@@ -462,6 +464,7 @@ def create_module_page_props(self) -> None:
                     pytest_node_id=str(module_path),
                     package_name=get_import_path(module_path),
                     is_benchmark=function_page.is_benchmark,
+                    is_state=function_page.is_state,
                     test_functions=[
                         TestFunction(
                             name=function_page.title,
@@ -475,6 +478,8 @@ def create_module_page_props(self) -> None:
                 existing_module_page = self.module_page_props[str(function_page.path)]
                 if function_page.is_benchmark:
                     existing_module_page.is_benchmark = True
+                if function_page.is_state:
+                    existing_module_page.is_state = True
                 existing_module_page.test_functions.append(
                     TestFunction(
                         name=function_page.title,
@@ -511,7 +516,12 @@ def add_directory_page_props(self) -> None:
             is_benchmark = any(
                 module_page.is_benchmark
                 for module_page in self.module_page_props.values()
-                if module_page.path.parent == directory
+                if directory in module_page.path.parents or module_page.path.parent == directory
+            )
+            is_state = any(
+                module_page.is_state
+                for module_page in self.module_page_props.values()
+                if directory in module_page.path.parents or module_page.path.parent == directory
             )
 
             self.page_props[str(directory)] = DirectoryPageProps(
@@ -526,6 +536,7 @@ def add_directory_page_props(self) -> None:
                 # init.py will be used for docstrings
                 package_name=get_import_path(directory),
                 is_benchmark=is_benchmark,
+                is_state=is_state,
             )
 
     def find_files_within_collection_scope(self, file_pattern: str) -> List[Path]:

src/pytest_plugins/filler/gen_test_doc/page_props.py

@@ -111,6 +111,7 @@ class PagePropsBase:
     pytest_node_id: str
     package_name: str
     is_benchmark: bool = False
+    is_state: bool = False
 
     @property
     @abstractmethod