Skip to content

Commit beb4674

Browse files
Merge pull request #54 from uberdeveloper/feat/mkdocs-setup
feat: Setup MkDocs with Material theme for documentation
2 parents 25dbaa9 + 754a769 commit beb4674

7 files changed

Lines changed: 1416 additions & 276 deletions

File tree

docs/.gitkeep

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# This file is to ensure the docs directory is created and tracked by git.

docs/api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# API Reference
2+
3+
::: omspy.order

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Welcome to Omspy
2+
3+
Documentation for the Omspy library.

mkdocs.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
site_name: Omspy Documentation
2+
theme:
3+
name: material
4+
nav:
5+
- Home: index.md
6+
- API Reference: api.md
7+
plugins:
8+
- search
9+
- mkdocstrings:
10+
handlers:
11+
python:
12+
paths: ["."] # Explicitly set search path to current directory (project root)
13+
options:
14+
show_root_heading: true
15+
show_source: true

0 commit comments

Comments
 (0)