Documentation
¶
Overview ¶
Package docs is the Stage-1 namespace for documentation generation, external docs fetching, and doc updating. See ../REFACTOR_PLAN.md.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderMarkdown ¶
func RenderMarkdown(doc *ProjectDoc) string
Types ¶
type DocGenerator ¶
type DocGenerator = engine.DocGenerator
func NewDocGenerator ¶
func NewDocGenerator(projectDir string) *DocGenerator
type DocSection ¶
type DocSection = engine.DocSection
type DocUpdater ¶
type DocUpdater = engine.DocUpdater
func NewDocUpdater ¶
func NewDocUpdater() *DocUpdater
type ExternalDocs ¶
type ExternalDocs = engine.ExternalDocs
func NewExternalDocs ¶
func NewExternalDocs() *ExternalDocs
type FunctionDoc ¶
type FunctionDoc = engine.FunctionDoc
type PackageDoc ¶
type PackageDoc = engine.PackageDoc
type ProjectDoc ¶
type ProjectDoc = engine.ProjectDoc
Source Files
Click to show internal directories.
Click to hide internal directories.