Fix griffe._internal references to griffelib._internal in docs

Co-authored-by: johnslavik <[email protected]>

Author: 2 people

docs/extensions/official/runtime-objects.md

@@ -15,7 +15,7 @@ This extension stores runtime objects corresponding to each loaded Griffe object
 >>> griffe_data["parse"].extra
 defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
 >>> griffe_data["Module"].extra
-defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class 'griffe._internal.models.Module'>}})
+defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class 'griffelib._internal.models.Module'>}})
 ```
 
 It can be useful in combination with mkdocstrings-python and custom templates, to iterate over object values or their attributes that couldn't be loaded by Griffe itself (for example, objects built dynamically and loaded as attributes won't have "members" to iterate over).

docs/guide/contributors/architecture.md

@@ -23,7 +23,7 @@ descriptions = {
     "site": "Documentation site, built with `make run mkdocs build` (git-ignored).",
     "src": "The source of our Python package(s). See [Sources](#sources) and [Program structure](#program-structure).",
     "src/griffe": "Our public API, exposed to users. See [Program structure](#program-structure).",
-    "src/griffe/_internal": "Our internal API, hidden from users. See [Program structure](#program-structure).",
+    "packages/griffelib/src/griffelib/_internal": "Our internal API, hidden from users. See [Program structure](#program-structure).",
     "tests": "Our test suite. See [Tests](#tests).",
     ".copier-answers.yml": "The answers file generated by [Copier](https://copier.readthedocs.io/en/stable/). See [Boilerplate](#boilerplate).",
     "devdeps.txt": "Our development dependencies specification. See [`make setup`][command-setup] command.",
@@ -104,11 +104,11 @@ Sources are located in the `src` folder, following the [src-layout](https://pack
 
 Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions.
 
-The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
+The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module.
 
 ## Program structure
 
-The internal API is contained within the `src/griffe/_internal` folder. The top-level `griffe/__init__.py` module exposes all the public API, by importing the internal objects from various submodules of `griffe._internal`.
+The internal API is contained within the `packages/griffelib/src/griffelib/_internal` folder. The top-level `griffe/__init__.py` module exposes all the public API, by importing the internal objects from `griffelib`, which itself imports from various submodules of `griffelib._internal`.
 
 Users then import `griffe` directly, or import objects from it.
 
@@ -122,7 +122,7 @@ if os.getenv("DEPLOY") == "true":
     from pydeps.target import Target
 
     cli.verbose = cli._not_verbose
-    options = cli.parse_args(["src/griffe", "--noshow", "--reverse"])
+    options = cli.parse_args(["packages/griffelib/src/griffelib", "--noshow", "--reverse"])
     colors.START_COLOR = 128
     target = Target(options["fname"])
     with target.chdir_work():

docs/guide/users/loading.md

@@ -214,10 +214,10 @@ from package1 import X
 False
 >>> package2["X"].target
 Traceback (most recent call last):
-  File "griffe/_internal/models.py", line 1375, in _resolve_target
+  File "griffelib/_internal/models.py", line 1375, in _resolve_target
     resolved = self.modules_collection.get_member(self.target_path)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  File "griffe/_internal/mixins.py", line 84, in get_member
+  File "griffelib/_internal/mixins.py", line 84, in get_member
     return self.members[parts[0]].get_member(parts[1:])  # type: ignore[attr-defined]
            ~~~~~~~~~~~~^^^^^^^^^^
 KeyError: 'package1'
@@ -226,13 +226,13 @@ The above exception was the direct cause of the following exception:
 
 Traceback (most recent call last):
   File "<stdin>", line 1, in <module>
-  File "griffe/_internal/dataclasses.py", line 1310, in target
+  File "griffelib/_internal/dataclasses.py", line 1310, in target
     self.resolve_target()
-  File "griffe/_internal/dataclasses.py", line 1369, in resolve_target
+  File "griffelib/_internal/dataclasses.py", line 1369, in resolve_target
     self._resolve_target()
-  File "griffe/_internal/dataclasses.py", line 1377, in _resolve_target
+  File "griffelib/_internal/dataclasses.py", line 1377, in _resolve_target
     raise AliasResolutionError(self) from error
-griffe._internal.exceptions.AliasResolutionError: Could not resolve alias package2.X pointing at package1.X (in package2/__init__.py:1)
+griffelib._internal.exceptions.AliasResolutionError: Could not resolve alias package2.X pointing at package1.X (in package2/__init__.py:1)
 ```
 
 As you can see in the interpreter session above, Griffe did not resolve the `X` alias. When we tried to access its target object anyway, it failed with a `KeyError`, which was raised again as an [`AliasResolutionError`][griffe.AliasResolutionError].
@@ -250,7 +250,7 @@ False  # Hmm?
 >>> package2["X"].target
 Traceback (most recent call last):
 ...
-griffe._internal.exceptions.AliasResolutionError: Could not resolve alias package2.X pointing at package1.X (in package2/__init__.py:1)
+griffelib._internal.exceptions.AliasResolutionError: Could not resolve alias package2.X pointing at package1.X (in package2/__init__.py:1)
 ```
 
 The same exception again? What happened here? We loaded both packages, but Griffe still failed to resolve the alias. That is expected; here is the explanation.

docs/guide/users/navigating.md

@@ -14,17 +14,17 @@ When [loading an object](loading.md), Griffe will give you back an instance of o
 ```python
 >>> import griffe
 >>> type(griffe.load("markdown"))
-<class 'griffe._internal.models.Module'>
+<class 'griffelib._internal.models.Module'>
 >>> type(griffe.load("markdown.core.Markdown"))
-<class 'griffe._internal.models.Class'>
+<class 'griffelib._internal.models.Class'>
 >>> type(griffe.load("markdown.Markdown"))
-<class 'griffe._internal.models.Alias'>
+<class 'griffelib._internal.models.Alias'>
 >>> type(griffe.load("markdown.core.markdown"))
-<class 'griffe._internal.models.Function'>
+<class 'griffelib._internal.models.Function'>
 >>> type(griffe.load("markdown.markdown"))
-<class 'griffe._internal.models.Alias'>
+<class 'griffelib._internal.models.Alias'>
 >>> type(griffe.load("markdown.Markdown.references"))
-<class 'griffe._internal.models.Attribute'>
+<class 'griffelib._internal.models.Attribute'>
 ```
 
 However deep the object is, Griffe loads the entire package. It means that in all the cases above, Griffe loaded the whole `markdown` package. The model instance Griffe gives you back is therefore part of a tree that you can navigate.

docs/reference/api/expressions.md

@@ -1,6 +1,6 @@
 # Expressions
 
-::: griffe._internal.expressions
+::: griffelib._internal.expressions
     options:
         members: false
         show_root_heading: false