Skip to content

docs: Remove apify-shared from documentation build #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vdusek merged 1 commit into from
Feb 24, 2026
Merged

docs: Remove apify-shared from documentation build #639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 0 additions & 18 deletions website/build_api_reference.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,6 @@ sed_no_backup() {
pydoc-markdown --quiet --dump > docspec-dump.jsonl
sed_no_backup "s#${PWD}/..#REPO_ROOT_PLACEHOLDER#g" docspec-dump.jsonl

# Create docpec dump from the right version of the apify-shared package
apify_shared_version=$(python -c "import apify_shared; print(apify_shared.__version__)")
apify_shared_tempdir=$(realpath "$(mktemp -d)")
git clone --quiet https://github.com/apify/apify-shared-python.git "${apify_shared_tempdir}"
cp ./pydoc-markdown.yml "${apify_shared_tempdir}/pydoc-markdown.yml"
sed_no_backup "s#search_path: \[../src\]#search_path: \[./src\]#g" "${apify_shared_tempdir}/pydoc-markdown.yml"

(
cd "${apify_shared_tempdir}";
git checkout --quiet "v${apify_shared_version}";
pydoc-markdown --quiet --dump > ./apify-shared-docspec-dump.jsonl
)

cp "${apify_shared_tempdir}/apify-shared-docspec-dump.jsonl" .
sed_no_backup "s#${apify_shared_tempdir}#REPO_ROOT_PLACEHOLDER#g" apify-shared-docspec-dump.jsonl

rm -rf "${apify_shared_tempdir}"

# Generate import shortcuts from the modules
python generate_module_shortcuts.py

Expand Down
2 changes: 1 addition & 1 deletion website/generate_module_shortcuts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def resolve_shortcuts(shortcuts: dict) -> None:


shortcuts = {}
for module_name in ['apify', 'apify_client', 'apify_shared']:
for module_name in ['apify', 'apify_client']:
try:
module = importlib.import_module(module_name)
module_shortcuts = get_module_shortcuts(module)
Expand Down
11 changes: 3 additions & 8 deletions website/transformDocs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,15 @@ const REPO_ROOT_PLACEHOLDER = 'REPO_ROOT_PLACEHOLDER';

const APIFY_CLIENT_REPO_URL = 'https://github.com/apify/apify-client-python';
const APIFY_SDK_REPO_URL = 'https://github.com/apify/apify-sdk-python';
const APIFY_SHARED_REPO_URL = 'https://github.com/apify/apify-shared-python';

const REPO_URL_PER_PACKAGE = {
'apify': APIFY_SDK_REPO_URL,
'apify_client': APIFY_CLIENT_REPO_URL,
'apify_shared': APIFY_SHARED_REPO_URL,
};

// For each package, get the installed version, and set the tag to the corresponding version
const TAG_PER_PACKAGE = {};
for (const pkg of ['apify', 'apify_client', 'apify_shared']) {
for (const pkg of ['apify', 'apify_client']) {
const spawnResult = spawnSync('python', ['-c', `import ${pkg}; print(${pkg}.__version__)`]);
if (spawnResult.status === 0) {
TAG_PER_PACKAGE[pkg] = `v${spawnResult.stdout.toString().trim()}`;
Expand Down Expand Up @@ -319,15 +317,12 @@ function main() {
]
};

// Load the docspec dump files of this module and of apify-shared
// Load the docspec dump file of this module
const thisPackageDocspecDump = fs.readFileSync('docspec-dump.jsonl', 'utf8');
const thisPackageModules = thisPackageDocspecDump.split('\n').filter((line) => line !== '');

const apifySharedDocspecDump = fs.readFileSync('apify-shared-docspec-dump.jsonl', 'utf8');
const apifySharedModules = apifySharedDocspecDump.split('\n').filter((line) => line !== '');

// Convert all the modules, store them in the root object
for (const module of [...thisPackageModules, ...apifySharedModules]) {
for (const module of thisPackageModules) {
const parsedModule = JSON.parse(module);
convertObject(parsedModule, typedocApiReference, parsedModule);
};
Expand Down