Vishesh 'ironeagle' Bangotra
b6306baafc
# Improve documentation look & feel via MkDocs Material template enhancements ## Summary This MR improves the overall **documentation experience and visual presentation** of the doc-forge docs by enhancing the MkDocs Material template configuration. The changes focus on **navigation usability, code readability, and richer Markdown rendering**, resulting in a cleaner and more professional documentation site. Docstring changes were made across the codebase for consistency, but this MR description focuses on the **template and presentation improvements**. --- ## Navigation Improvements The navigation system has been enhanced to provide a clearer structure and better discoverability. Key improvements include: * Section-aware navigation in the sidebar * Automatic expansion of module/package hierarchy * Scroll tracking within the sidebar * Clickable package index pages Material navigation features added: * `navigation.sections` * `navigation.expand` * `navigation.tracking` * `navigation.indexes` This results in a **single cohesive navigation tree** that exposes the entire documentation hierarchy from the sidebar. --- ## Code Block Improvements Code blocks previously appeared relatively plain. The template now enables richer syntax highlighting and improved readability. Enhancements include: * Syntax highlighting using `pymdownx.highlight` * Line numbers for code blocks * Anchored line numbers for deep linking * Improved fenced code block rendering Additional Material features: * `content.code.copy` — copy button for code blocks * `content.code.annotate` — support for code annotations These changes significantly improve the readability of examples and API snippets throughout the documentation. --- ## Markdown Rendering Enhancements Additional Markdown extensions were enabled to support richer documentation features: * `pymdownx.superfences` for advanced fenced blocks * `pymdownx.inlinehilite` for inline code highlighting * `pymdownx.snippets` for reusable snippets * `admonition` and `pymdownx.details` for callouts and collapsible sections * `pymdownx.tabbed` for tabbed content blocks * `pymdownx.tasklist` for checklist-style items * `tables`, `footnotes`, and advanced formatting extensions These extensions make it easier to write expressive and structured documentation. --- ## Search Experience The documentation search experience has been improved using Material search features: * `search.highlight` * `search.share` * `search.suggest` These enhancements provide: * highlighted search matches * sharable search URLs * auto-suggestions while typing --- ## mkdocstrings Improvements The mkdocstrings configuration has been expanded to produce clearer API documentation. Notable improvements include: * grouping objects by category * explicit category headings * improved symbol headings * cleaner object path display This results in more structured API documentation pages. --- ## Result Overall, these changes provide: * cleaner and more intuitive navigation * significantly improved code presentation * richer Markdown capabilities * better search usability The documentation now has a **more polished, modern appearance** and improved usability for both readers and contributors. Reviewed-on: #5 Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com> Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
63 lines
1.7 KiB
Python
63 lines
1.7 KiB
Python
"""
|
|
Renderer base interfaces and configuration models.
|
|
|
|
This module defines the base protocol and configuration container used by
|
|
doc-forge renderers. Concrete renderer implementations should implement the
|
|
``DocRenderer`` protocol.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
from typing import Protocol
|
|
|
|
from docforge.models import Project
|
|
|
|
|
|
class RendererConfig:
|
|
"""
|
|
Configuration container for documentation renderers.
|
|
|
|
A ``RendererConfig`` instance groups together the project model and the
|
|
output directory used during rendering.
|
|
|
|
Attributes:
|
|
out_dir: Directory where generated documentation files will be written.
|
|
project: Documentation project model to be rendered.
|
|
"""
|
|
|
|
def __init__(self, out_dir: Path, project: Project) -> None:
|
|
"""
|
|
Initialize a RendererConfig instance.
|
|
|
|
Args:
|
|
out_dir: Target directory where documentation files should be written.
|
|
project: Introspected project model to render.
|
|
"""
|
|
self.out_dir = out_dir
|
|
self.project = project
|
|
|
|
|
|
class DocRenderer(Protocol):
|
|
"""
|
|
Protocol defining the interface for documentation renderers.
|
|
|
|
Implementations of this protocol are responsible for transforming a
|
|
``Project`` model into renderer-specific documentation sources.
|
|
"""
|
|
|
|
name: str
|
|
|
|
def generate_sources(
|
|
self,
|
|
project: Project,
|
|
out_dir: Path,
|
|
) -> None:
|
|
"""
|
|
Generate renderer-specific documentation sources.
|
|
|
|
Args:
|
|
project: Project model containing modules and documentation objects.
|
|
out_dir: Directory where generated documentation sources
|
|
should be written.
|
|
"""
|
|
...
|