Skip to content

Commit dc6d24b

Browse files
authored
Add initial MkDocs configuration file (#62)
* Add initial MkDocs configuration file Introduces mkdocs.yml with site metadata, navigation structure, theme, plugins, and markdown extensions for Hatchling project documentation. * Add Read the Docs configuration file
1 parent ca4ab7d commit dc6d24b

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
13+
# Build documentation with Mkdocs
14+
mkdocs:
15+
configuration: mkdocs.yml
16+
17+
# Optionally, but recommended,
18+
# declare the Python requirements required to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
# python:
21+
# install:
22+
# - requirements: docs/requirements.txt

mkdocs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
site_name: Hatchling Docs
2+
site_description: Documentation for the Hatchling project
3+
site_url: https://crackingshells.github.io/Hatchling/
4+
5+
repo_name: CrackingShells/Hatchling
6+
repo_url: https://github.com/CrackingShells/Hatchling
7+
8+
docs_dir: docs
9+
10+
theme:
11+
name: mkdocs
12+
13+
nav:
14+
- Home: index.md
15+
- Users:
16+
- Chat Commands: articles/users/chat_commands.md
17+
- Settings: articles/users/settings.md
18+
- Settings Reference: articles/users/settings_reference.md
19+
- Language Support: articles/users/language_support.md
20+
- Developers:
21+
- Versioning: articles/devs/versioning.md
22+
- Settings Architecture: articles/devs/settings_architecture.md
23+
- Event System Architecture: articles/devs/event_system_architecture.md
24+
- i18n Support: articles/devs/i18n_support.md
25+
- Contributing: articles/devs/CONTRIBUTING.md
26+
- Appendices:
27+
- Glossary: articles/appendices/glossary.md
28+
- Changelog: CHANGELOG.md
29+
30+
plugins:
31+
- search
32+
33+
markdown_extensions:
34+
- admonition
35+
- toc:
36+
permalink: true
37+
- tables
38+
- footnotes
39+
- codehilite

0 commit comments

Comments
 (0)