Skip to content

Commit 0a87ba8

Browse files
committed
docs: add mkdocs.yml for ReadTheDocs and Python version requirement
- Created mkdocs.yml with Material theme configuration - Added navigation structure for all documentation - Updated README badge to show Python >= 3.8 requirement - Added Python version note in installation section
1 parent 350391f commit 0a87ba8

File tree

2 files changed

+107
-2
lines changed

2 files changed

+107
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
[![PyPI](https://img.shields.io/pypi/v/fakestack)](https://pypi.org/project/fakestack/)
1010
[![npm](https://img.shields.io/npm/v/fakestack)](https://www.npmjs.com/package/fakestack)
11-
[![Python](https://img.shields.io/pypi/pyversions/fakestack)](https://pypi.org/project/fakestack/)
11+
[![Python](https://img.shields.io/badge/python-%3E%3D3.8-blue)](https://pypi.org/project/fakestack/)
1212
[![Node](https://img.shields.io/node/v/fakestack)](https://www.npmjs.com/package/fakestack)
1313
[![Documentation](https://readthedocs.org/projects/fake-stack/badge/?version=latest)](https://fake-stack.readthedocs.io/)
1414
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
@@ -38,7 +38,7 @@ Generate databases from JSON schemas with realistic fake data. **10-50x faster**
3838

3939
Choose your preferred package manager:
4040

41-
**Python (pip)**
41+
**Python (pip)** - Requires Python >= 3.8
4242
```bash
4343
pip install fakestack
4444
```

mkdocs.yml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
site_name: Fakestack Documentation
2+
site_url: https://fake-stack.readthedocs.io/
3+
site_description: High-performance database generator with realistic fake data
4+
site_author: Devendra Pratap Singh
5+
repo_url: https://github.com/0xdps/fake-stack
6+
repo_name: 0xdps/fake-stack
7+
8+
theme:
9+
name: material
10+
palette:
11+
- scheme: default
12+
primary: indigo
13+
accent: indigo
14+
toggle:
15+
icon: material/brightness-7
16+
name: Switch to dark mode
17+
- scheme: slate
18+
primary: indigo
19+
accent: indigo
20+
toggle:
21+
icon: material/brightness-4
22+
name: Switch to light mode
23+
features:
24+
- navigation.tabs
25+
- navigation.sections
26+
- navigation.top
27+
- search.suggest
28+
- search.highlight
29+
- content.tabs.link
30+
- content.code.copy
31+
icon:
32+
repo: fontawesome/brands/github
33+
34+
plugins:
35+
- search
36+
- awesome-pages
37+
38+
markdown_extensions:
39+
- pymdownx.highlight:
40+
anchor_linenums: true
41+
- pymdownx.inlinehilite
42+
- pymdownx.snippets
43+
- pymdownx.superfences
44+
- pymdownx.tabbed:
45+
alternate_style: true
46+
- admonition
47+
- pymdownx.details
48+
- pymdownx.emoji:
49+
emoji_index: !!python/name:material.extensions.emoji.twemoji
50+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
51+
- attr_list
52+
- md_in_html
53+
- tables
54+
- toc:
55+
permalink: true
56+
57+
nav:
58+
- Home: index.md
59+
- Getting Started:
60+
- Installation: getting-started.md
61+
- Quick Start: getting-started.md#quick-start
62+
- Basic Usage: getting-started.md#basic-usage
63+
- Schema:
64+
- Schema Reference: schema-reference.md
65+
- Database Configuration: schema-reference.md#database-configuration
66+
- Table Definitions: schema-reference.md#table-definitions
67+
- Data Population: schema-reference.md#data-population
68+
- Generators:
69+
- Available Generators: generators.md
70+
- Custom Generators: CUSTOM_GENERATORS.md
71+
- Template Examples: TEMPLATE_EXAMPLES.md
72+
- Databases:
73+
- Database Support: databases.md
74+
- SQLite: databases.md#sqlite
75+
- MySQL: databases.md#mysql
76+
- PostgreSQL: databases.md#postgresql
77+
- MariaDB: databases.md#mariadb
78+
- MS SQL Server: databases.md#ms-sql-server
79+
- CockroachDB: databases.md#cockroachdb
80+
- API Reference:
81+
- Overview: api-reference.md
82+
- Python API: api-reference.md#python-api
83+
- Node.js API: api-reference.md#nodejs-api
84+
- Go Core: api-reference.md#go-core
85+
- Examples:
86+
- Real-World Examples: examples.md
87+
- E-commerce: examples.md#e-commerce
88+
- Blog Platform: examples.md#blog-platform
89+
- Social Network: examples.md#social-network
90+
- Troubleshooting: troubleshooting.md
91+
- Development:
92+
- Contributing: ../CONTRIBUTING.md
93+
- Development Setup: ../DEVELOPMENT.md
94+
- Changelog: ../CHANGELOG.md
95+
96+
extra:
97+
social:
98+
- icon: fontawesome/brands/github
99+
link: https://github.com/0xdps/fake-stack
100+
- icon: fontawesome/brands/python
101+
link: https://pypi.org/project/fakestack/
102+
- icon: fontawesome/brands/npm
103+
link: https://www.npmjs.com/package/fakestack
104+
version:
105+
provider: mike

0 commit comments

Comments
 (0)