Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/api/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Griffe is able to analyze code both statically and dynamically.
## **Deprecated API**

<!-- YORE: Bump 2: Remove line. -->
::: griffe.ExportedName
<!-- ::: griffe.ExportedName -->
2 changes: 2 additions & 0 deletions docs/reference/api/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

DANGER: **Deprecated utilities.** We have decided to stop exposing Git-related utilities as it's not a core part of the library's functionality. The functions documented on this page will become unavailable in the next major version.

<!-- These git utilities have been removed/made internal
::: griffe.assert_git_repo

::: griffe.get_latest_tag

::: griffe.get_repo_root

::: griffe.tmp_worktree
-->
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_url: "https://mkdocstrings.github.io/griffe"
repo_url: "https://github.com/mkdocstrings/griffe"
repo_name: "mkdocstrings/griffe"
site_dir: "site"
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src]
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src, packages/griffelib/src, packages/griffecli/src]
copyright: Copyright &copy; 2021 Timothée Mazzucotelli
edit_uri: edit/main/docs/

Expand Down Expand Up @@ -218,7 +218,8 @@ plugins:
- url: https://docs.python.org/3/objects.inv
domains: [std, py]
- https://typing-extensions.readthedocs.io/en/latest/objects.inv
paths: [src, scripts, .]
paths: [src, packages/griffelib/src, packages/griffecli/src, scripts, .]
load_external_modules: true
options:
backlinks: tree
docstring_options:
Expand Down
15 changes: 6 additions & 9 deletions scripts/gen_structure_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ def render_internal_api(heading_level: int = 4) -> None:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
internal_api = src / "griffe" / "_internal"
internal_api = root / "packages" / "griffelib" / "src" / "griffelib" / "_internal"
print(_comment_block(internal_api / "__init__.py"))
_render_api(internal_api, internal_api, heading_level)

Expand All @@ -81,9 +80,8 @@ def render_public_api(heading_level: int = 4) -> None:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
public_api = src / "griffe"
print(f"{'#' * heading_level} `griffe`\n")
public_api = root / "packages" / "griffelib" / "src" / "griffelib"
print(f"{'#' * heading_level} `griffelib`\n")
print(_comment_block(public_api / "__init__.py"))


Expand All @@ -94,7 +92,6 @@ def render_entrypoint(heading_level: int = 4) -> None:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
public_api = src / "griffe"
print(f"{'#' * heading_level} `griffelib.__main__`\n")
print(_comment_block(public_api / "__main__.py"))
cli_api = root / "packages" / "griffecli" / "src" / "griffecli"
print(f"{'#' * heading_level} `griffecli.__main__`\n")
print(_comment_block(cli_api / "__main__.py"))
Loading