From e38249bc385ebf77d6a578bdfbba7aa34fc328dd Mon Sep 17 00:00:00 2001 From: Jedd Morgan <45512892+JR-Morgan@users.noreply.github.com> Date: Fri, 28 Feb 2025 16:37:54 +0000 Subject: [PATCH] Moved docs one layer higher --- src/{specklepy => }/docs/index.md | 0 src/docs/speckle_automate/automate_context.md | 1 + src/{specklepy/docs/api.md => docs/specklepy/api/client.md} | 3 --- src/{specklepy/docs => docs/specklepy}/objects/base.md | 0 src/docs/specklepy/objects/geometry/arc.md | 1 + src/{specklepy => }/mkdocs.yml | 2 +- src/specklepy/docs/objects/geometry/arc.md | 1 - 7 files changed, 3 insertions(+), 5 deletions(-) rename src/{specklepy => }/docs/index.md (100%) create mode 100644 src/docs/speckle_automate/automate_context.md rename src/{specklepy/docs/api.md => docs/specklepy/api/client.md} (55%) rename src/{specklepy/docs => docs/specklepy}/objects/base.md (100%) create mode 100644 src/docs/specklepy/objects/geometry/arc.md rename src/{specklepy => }/mkdocs.yml (97%) delete mode 100644 src/specklepy/docs/objects/geometry/arc.md diff --git a/src/specklepy/docs/index.md b/src/docs/index.md similarity index 100% rename from src/specklepy/docs/index.md rename to src/docs/index.md diff --git a/src/docs/speckle_automate/automate_context.md b/src/docs/speckle_automate/automate_context.md new file mode 100644 index 0000000..d314642 --- /dev/null +++ b/src/docs/speckle_automate/automate_context.md @@ -0,0 +1 @@ +::: speckle_automate.automation_context.AutomationContext diff --git a/src/specklepy/docs/api.md b/src/docs/specklepy/api/client.md similarity index 55% rename from src/specklepy/docs/api.md rename to src/docs/specklepy/api/client.md index 259e001..0949f26 100644 --- a/src/specklepy/docs/api.md +++ b/src/docs/specklepy/api/client.md @@ -1,4 +1 @@ -# API Reference - -::: specklepy ::: specklepy.api.client.SpeckleClient diff --git a/src/specklepy/docs/objects/base.md b/src/docs/specklepy/objects/base.md similarity index 100% rename from src/specklepy/docs/objects/base.md rename to src/docs/specklepy/objects/base.md diff --git a/src/docs/specklepy/objects/geometry/arc.md b/src/docs/specklepy/objects/geometry/arc.md new file mode 100644 index 0000000..a2c1395 --- /dev/null +++ b/src/docs/specklepy/objects/geometry/arc.md @@ -0,0 +1 @@ +::: specklepy.objects.geometry.arc.Arc diff --git a/src/specklepy/mkdocs.yml b/src/mkdocs.yml similarity index 97% rename from src/specklepy/mkdocs.yml rename to src/mkdocs.yml index 9a56faa..72e3702 100644 --- a/src/specklepy/mkdocs.yml +++ b/src/mkdocs.yml @@ -18,7 +18,7 @@ plugins: show_signature_annotations: true signature_crossrefs: true show_if_no_docstring: true - import: + inventories: - url: https://docs.python.org/3/objects.inv domains: [py, std] # selection: diff --git a/src/specklepy/docs/objects/geometry/arc.md b/src/specklepy/docs/objects/geometry/arc.md deleted file mode 100644 index 9a13315..0000000 --- a/src/specklepy/docs/objects/geometry/arc.md +++ /dev/null @@ -1 +0,0 @@ -::: objects.geometry.arc.Arc