Update API ignore section to allow links to be created in auto-genera…

…ted API

.gitignore

@@ -68,10 +68,6 @@ _readthedocs/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
 .python-version
 
@@ -87,21 +83,9 @@ ENV*/
 env.bak/
 venv.bak/
 
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
 # ruff
 .ruff_cache/
 
-# Pyre type checker
-.pyre/
-**__pycache__
-
 # PyCharm
 .idea/
 

.readthedocs.yml

@@ -8,8 +8,7 @@ build:
     python: '3.11'  # This needs to stay in sync with pyproject.toml and any CI scripts
     nodejs: '18'  # This needs to stay in sync with any CI scripts
   jobs:
-    post_install:
-      - npm install -g @mermaid-js/mermaid-cli
+    post_install: [npm install -g @mermaid-js/mermaid-cli]
 # Configuration
 python:
   install:

docs/conf.py

@@ -215,11 +215,9 @@ def skip_member(
             what == "package"
             and obj.short_name not in _package_set  # pyright: ignore [reportUnknownMemberType]
         )
-        or (
-            f"{os.path.sep}commands{os.path.sep}" in obj.pathname
-            or obj.pathname.endswith(f"{os.path.sep}commands")
-            or "_commands" in name
-        )
+        or f"{os.path.sep}commands{os.path.sep}" in obj.pathname
+        or obj.pathname.endswith(f"{os.path.sep}commands")
+        or ("_commands" in name and "ieee" not in name)
     ):
         skip = True
 

src/tm_devices/commands/_helpers/generic_commands.py

@@ -61,12 +61,6 @@ class BaseCmd:
     """A class defining the base syntax of a command class.
 
     The syntax is accessible through the ``.cmd_syntax`` property.
-
-    Examples:
-        >>> class Command(BaseCmd):
-        ...     '''A basic command.'''
-        >>> command = Command(None, "cmd")
-        >>> assert command.cmd_syntax == "cmd"
     """
 
     def __init__(self, device: Optional["Device"], cmd_syntax: str) -> None: