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>
41 lines
1.1 KiB
Python
41 lines
1.1 KiB
Python
"""
|
||
Model layer for doc-forge.
|
||
|
||
The ``docforge.models`` package defines the core data structures used to
|
||
represent Python source code as a structured documentation model.
|
||
|
||
---
|
||
|
||
Overview
|
||
--------
|
||
|
||
The model layer forms the central intermediate representation used throughout
|
||
doc-forge. Python modules and objects discovered during introspection are
|
||
converted into a hierarchy of documentation models that can later be rendered
|
||
into different documentation formats.
|
||
|
||
Key components:
|
||
|
||
- **Project** – Root container representing an entire documented codebase.
|
||
- **Module** – Representation of a Python module or package containing
|
||
documented members.
|
||
- **DocObject** – Recursive structure representing Python objects such as
|
||
classes, functions, methods, and attributes.
|
||
|
||
These models are intentionally **renderer-agnostic**, allowing the same
|
||
documentation structure to be transformed into multiple output formats
|
||
(e.g., MkDocs, MCP, or other renderers).
|
||
|
||
---
|
||
"""
|
||
|
||
from .project import Project
|
||
from .module import Module
|
||
from .object import DocObject
|
||
|
||
__all__ = [
|
||
"Project",
|
||
"Module",
|
||
"DocObject",
|
||
]
|