Vishesh 'ironeagle' Bangotra
4fa3bc0533
- Require `--site-name` when generating mkdocs.yml to ensure valid configs - Inject site_name explicitly into generated mkdocs.yml - Echo MkDocs serve URL (http://127.0.0.1:8000) before starting server - Fix MkDocs nav emission to correctly resolve docs-relative paths - Align MkDocs-related optional dependencies with a compatible, pinned set These changes make MkDocs generation valid by default, improve UX when serving, and prevent nav path and plugin compatibility issues.
95 lines
2.0 KiB
TOML
95 lines
2.0 KiB
TOML
[build-system]
|
|
requires = ["setuptools>=68", "wheel"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
|
|
[project]
|
|
name = "doc-forge"
|
|
version = "0.0.1"
|
|
description = "A renderer-agnostic Python documentation compiler"
|
|
readme = "README.md"
|
|
requires-python = ">=3.10"
|
|
license = { text = "MIT" }
|
|
|
|
authors = [
|
|
{ name = "Aetos Skia", email = "dev@aetoskia.com" }
|
|
]
|
|
maintainers = [
|
|
{ name = "Aetos Skia", email = "dev@aetoskia.com" }
|
|
]
|
|
classifiers = [
|
|
"Development Status :: 3 - Alpha",
|
|
"Intended Audience :: Developers",
|
|
"License :: OSI Approved :: MIT License",
|
|
"Programming Language :: Python :: 3",
|
|
"Programming Language :: Python :: 3.10",
|
|
"Programming Language :: Python :: 3.11",
|
|
"Programming Language :: Python :: 3.12",
|
|
"Framework :: FastAPI",
|
|
"Topic :: Software Development :: Libraries",
|
|
"Topic :: Internet :: WWW/HTTP :: HTTP Servers",
|
|
]
|
|
|
|
|
|
dependencies = [
|
|
"griffe>=0.45.0",
|
|
"click>=8.0.0",
|
|
"pydantic>=2.0.0",
|
|
]
|
|
|
|
[project.scripts]
|
|
doc-forge = "docforge.cli.main:main"
|
|
|
|
[project.optional-dependencies]
|
|
mkdocs = [
|
|
"mkdocs==1.6.1",
|
|
"mkdocs-material==9.6.23",
|
|
|
|
"mkdocstrings==0.25.2",
|
|
"mkdocstrings-python==1.10.8",
|
|
"mkdocs-autorefs==0.5.0",
|
|
|
|
"pymdown-extensions==10.16.1",
|
|
"neoteroi-mkdocs==1.1.3",
|
|
]
|
|
sphinx = [
|
|
"sphinx>=5.0.0",
|
|
"sphinx-autodoc-typehints>=1.19.0",
|
|
]
|
|
mcp = [
|
|
"mcp>=1.0.0",
|
|
]
|
|
dev = [
|
|
"pytest>=7.0.0",
|
|
"pytest-cov>=4.0.0",
|
|
"black>=23.0.0",
|
|
"ruff>=0.1.0",
|
|
"mypy>=1.0.0",
|
|
]
|
|
|
|
|
|
[project.urls]
|
|
Homepage = "https://git.aetoskia.com/aetos/doc-forge"
|
|
Documentation = "https://git.aetoskia.com/aetos/doc-forge#readme"
|
|
Repository = "https://git.aetoskia.com/aetos/doc-forge.git"
|
|
Issues = "https://git.aetoskia.com/aetos/doc-forge/issues"
|
|
Versions = "https://git.aetoskia.com/aetos/doc-forge/tags"
|
|
|
|
|
|
[tool.setuptools]
|
|
packages = { find = { include = ["docforge*"] } }
|
|
|
|
[tool.setuptools.package-data]
|
|
docforge = ["templates/*.yml"]
|
|
|
|
|
|
[tool.ruff]
|
|
line-length = 100
|
|
target-version = "py310"
|
|
|
|
|
|
[tool.mypy]
|
|
python_version = "3.10"
|
|
strict = true
|
|
ignore_missing_imports = true
|