Skip to content

Commit 3893399

Browse files
committed
refactor: include pre-built docs/ and simplify setup.py
Replace dynamic Starlight creation with pre-built docs/ directory. This avoids npm downloads during setup and speeds up project initialization.
1 parent 164731c commit 3893399

File tree

12 files changed

+6664
-169
lines changed

12 files changed

+6664
-169
lines changed

_starlight/src/content/docs/getting_started.md

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

_starlight/src/content/docs/index.mdx

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

docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ export default defineConfig({
88
[rehypeExternalLinks, { target: '_blank', rel: ['noopener', 'noreferrer'] }]
99
],
1010
},
11-
site: 'https://{{GITHUB_USERNAME}}.github.io',
12-
base: '/{{PACKAGE_NAME}}',
11+
site: 'https://opencitations.github.io',
12+
base: '/python-package-template',
1313

1414
integrations: [
1515
starlight({
16-
title: '{{PACKAGE_TITLE}}',
17-
description: '{{DESCRIPTION}}',
16+
title: 'Python Package Template',
17+
description: 'A template for creating Python packages with UV, pytest, and Starlight documentation',
1818

1919
social: [
20-
{ icon: 'github', label: 'GitHub', href: 'https://github.com/{{GITHUB_USERNAME}}/{{PACKAGE_NAME}}' },
20+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/opencitations/python-package-template' },
2121
],
2222

2323
sidebar: [

0 commit comments

Comments
 (0)