Skip to content

Commit a730c9e

Browse files
Aryamanz29claude
andcommitted
docs: replace Sphinx with MkDocs + mkdocstrings
- Replace sphinx/furo/sphinx-autoapi with mkdocs, mkdocs-material, and mkdocstrings in the docs dependency group - Add mkdocs.yml with Material theme and mkdocstrings plugin - Add docs/index.md landing page and api/ reference pages - Remove all Sphinx .rst files (conf.py, index.rst, Makefile, hundreds of manual asset stubs) - Update GitHub Actions workflow to use mkdocs build + deploy site/ Build time is now ~4s vs minutes with sphinx-autoapi. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 2a0f1ab commit a730c9e

491 files changed

Lines changed: 523 additions & 5612 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€Ž.github/workflows/pyatlan-docs.yamlβ€Ž

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SPDX-License-Identifier: Apache-2.0
22
# Copyright 2023 Atlan Pte. Ltd.
3-
name: Pyatlan Sphinx Docs Build
3+
name: Pyatlan MkDocs Build
44

55
on:
66
push:
@@ -10,7 +10,7 @@ on:
1010
jobs:
1111
publish-docs:
1212
runs-on: ubuntu-latest
13-
name: "Sphinx"
13+
name: "MkDocs"
1414
steps:
1515
- name: Checkout
1616
uses: actions/checkout@v4
@@ -26,11 +26,11 @@ jobs:
2626
- name: Install dependencies
2727
run: uv sync --group docs
2828

29-
- name: Build Sphinx docs
30-
run: uv run sphinx-build -b html docs docs/_build
29+
- name: Build MkDocs
30+
run: uv run mkdocs build
3131

3232
- name: Publish to GitHub Pages
3333
uses: peaceiris/actions-gh-pages@v4
3434
with:
3535
github_token: ${{ secrets.GITHUB_TOKEN }}
36-
publish_dir: docs/_build
36+
publish_dir: site

β€Ždocs/Makefileβ€Ž

Lines changed: 0 additions & 20 deletions
This file was deleted.

β€Ždocs/api/cache.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cache
2+
3+
::: pyatlan.cache

β€Ždocs/api/client.mdβ€Ž

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Client
2+
3+
## AtlanClient
4+
5+
::: pyatlan.client.atlan.AtlanClient
6+
7+
## Asset Client
8+
9+
::: pyatlan.client.asset.AssetClient
10+
11+
## Audit Client
12+
13+
::: pyatlan.client.audit.AuditClient
14+
15+
## File Client
16+
17+
::: pyatlan.client.file.FileClient
18+
19+
## Group Client
20+
21+
::: pyatlan.client.group.GroupClient
22+
23+
## Role Client
24+
25+
::: pyatlan.client.role.RoleClient
26+
27+
## Token Client
28+
29+
::: pyatlan.client.token.TokenClient
30+
31+
## User Client
32+
33+
::: pyatlan.client.user.UserClient
34+
35+
## Typedef Client
36+
37+
::: pyatlan.client.typedef.TypeDefClient
38+
39+
## Workflow Client
40+
41+
::: pyatlan.client.workflow.WorkflowClient

β€Ždocs/api/errors.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Errors
2+
3+
::: pyatlan.errors

β€Ždocs/api/events.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Events
2+
3+
::: pyatlan.events

β€Ždocs/api/model.mdβ€Ž

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Models
2+
3+
## Search
4+
5+
::: pyatlan.model.search
6+
7+
## Typedef
8+
9+
::: pyatlan.model.typedef
10+
11+
## Packages
12+
13+
::: pyatlan.model.packages

β€Ždocs/api/utils.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Utils
2+
3+
::: pyatlan.utils

β€Ždocs/asset/accesscontrol.rstβ€Ž

Lines changed: 0 additions & 10 deletions
This file was deleted.

β€Ždocs/asset/adf.rstβ€Ž

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
Β (0)