docs: bring docforge docstrings and wiki to GSDFC standard
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README - rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs - add pydoclint (google style) gate to dev extras and pyproject config - fix mcp nav resources doc:// -> docs:// - refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group - update wiki pages and add GSDFC + MCP guides under 05_development
This commit is contained in:
@@ -1,3 +0,0 @@
|
||||
# Api Utils
|
||||
|
||||
::: docforge.cli.api_utils
|
||||
@@ -1,3 +0,0 @@
|
||||
# Commands
|
||||
|
||||
::: docforge.cli.commands
|
||||
@@ -1,8 +0,0 @@
|
||||
# Cli
|
||||
|
||||
::: docforge.cli
|
||||
- [Api Utils](api_utils.md)
|
||||
- [Commands](commands.md)
|
||||
- [Main](main.md)
|
||||
- [Mcp Utils](mcp_utils.md)
|
||||
- [Mkdocs Utils](mkdocs_utils.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Main
|
||||
|
||||
::: docforge.cli.main
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mcp Utils
|
||||
|
||||
::: docforge.cli.mcp_utils
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mkdocs Utils
|
||||
|
||||
::: docforge.cli.mkdocs_utils
|
||||
@@ -1,9 +0,0 @@
|
||||
# Docforge
|
||||
|
||||
::: docforge
|
||||
- [Cli](cli/)
|
||||
- [Loaders](loaders/)
|
||||
- [Models](models/)
|
||||
- [Nav](nav/)
|
||||
- [Renderers](renderers/)
|
||||
- [Servers](servers/)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Griffe Loader
|
||||
|
||||
::: docforge.loaders.griffe_loader
|
||||
@@ -1,4 +0,0 @@
|
||||
# Loaders
|
||||
|
||||
::: docforge.loaders
|
||||
- [Griffe Loader](griffe_loader.md)
|
||||
@@ -1,6 +0,0 @@
|
||||
# Models
|
||||
|
||||
::: docforge.models
|
||||
- [Module](module.md)
|
||||
- [Object](object.md)
|
||||
- [Project](project.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Module
|
||||
|
||||
::: docforge.models.module
|
||||
@@ -1,3 +0,0 @@
|
||||
# Object
|
||||
|
||||
::: docforge.models.object
|
||||
@@ -1,3 +0,0 @@
|
||||
# Project
|
||||
|
||||
::: docforge.models.project
|
||||
@@ -1,7 +0,0 @@
|
||||
# Nav
|
||||
|
||||
::: docforge.nav
|
||||
- [Mkdocs](mkdocs.md)
|
||||
- [Resolver](resolver.md)
|
||||
- [Spec](spec.md)
|
||||
- [Wiki](wiki.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mkdocs
|
||||
|
||||
::: docforge.nav.mkdocs
|
||||
@@ -1,3 +0,0 @@
|
||||
# Resolver
|
||||
|
||||
::: docforge.nav.resolver
|
||||
@@ -1,3 +0,0 @@
|
||||
# Spec
|
||||
|
||||
::: docforge.nav.spec
|
||||
@@ -1,3 +0,0 @@
|
||||
# Wiki
|
||||
|
||||
::: docforge.nav.wiki
|
||||
@@ -1,3 +0,0 @@
|
||||
# Base
|
||||
|
||||
::: docforge.renderers.base
|
||||
@@ -1,6 +0,0 @@
|
||||
# Renderers
|
||||
|
||||
::: docforge.renderers
|
||||
- [Base](base.md)
|
||||
- [Mcp Renderer](mcp_renderer.md)
|
||||
- [Mkdocs Renderer](mkdocs_renderer.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mcp Renderer
|
||||
|
||||
::: docforge.renderers.mcp_renderer
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mkdocs Renderer
|
||||
|
||||
::: docforge.renderers.mkdocs_renderer
|
||||
@@ -1,4 +0,0 @@
|
||||
# Servers
|
||||
|
||||
::: docforge.servers
|
||||
- [Mcp Server](mcp_server.md)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Mcp Server
|
||||
|
||||
::: docforge.servers.mcp_server
|
||||
Reference in New Issue
Block a user