Add MkDocs documentation framework #2
Draft
+554
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sets up MkDocs with Material theme as the documentation infrastructure for pgvector-python.
Changes
mkdocs.ymlwith Material theme, syntax highlighting, search, and dark/light mode togglemkdocs>=1.5.0andmkdocs-material>=9.0.0torequirements.txtdocs/index.md- Project overview and quick startdocs/getting-started/installation.md- Setup instructions for all 8 supported database adaptersdocs/examples/openai.md- Complete OpenAI embeddings example with code samplesdocs/README.md- Contributor guidemake docsandmake docs-servetargets.gitignoreto excludesite/build artifactsUsage
Build documentation:
Serve locally for development:
The navigation structure and content organization in
mkdocs.ymlprovides a starting point for expanding documentation page by page.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.