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>
76 lines
2.0 KiB
Python
76 lines
2.0 KiB
Python
"""
|
|
Documentation model representing a project.
|
|
|
|
This module defines the ``Project`` class, the top-level container used by
|
|
doc-forge to represent a documented codebase. A ``Project`` aggregates multiple
|
|
modules and provides access to them through a unified interface.
|
|
"""
|
|
|
|
from typing import Dict, Iterable
|
|
|
|
from docforge.models.module import Module
|
|
|
|
|
|
class Project:
|
|
"""
|
|
Representation of a documentation project.
|
|
|
|
A ``Project`` serves as the root container for all modules discovered during
|
|
introspection. Each module is stored by its dotted import path.
|
|
|
|
Attributes:
|
|
name: Name of the project.
|
|
modules: Mapping of module paths to ``Module`` instances.
|
|
"""
|
|
|
|
def __init__(self, name: str) -> None:
|
|
"""
|
|
Initialize a Project instance.
|
|
|
|
Args:
|
|
name: Name used to identify the documentation project.
|
|
"""
|
|
self.name = name
|
|
self.modules: Dict[str, Module] = {}
|
|
|
|
def add_module(self, module: Module) -> None:
|
|
"""
|
|
Register a module in the project.
|
|
|
|
Args:
|
|
module: Module instance to add to the project.
|
|
"""
|
|
self.modules[module.path] = module
|
|
|
|
def get_module(self, path: str) -> Module:
|
|
"""
|
|
Retrieve a module by its dotted path.
|
|
|
|
Args:
|
|
path: Fully qualified dotted module path (for example ``pkg.module``).
|
|
|
|
Returns:
|
|
The corresponding ``Module`` instance.
|
|
|
|
Raises:
|
|
KeyError: If the module does not exist in the project.
|
|
"""
|
|
return self.modules[path]
|
|
|
|
def get_all_modules(self) -> Iterable[Module]:
|
|
"""
|
|
Return all modules contained in the project.
|
|
|
|
Returns:
|
|
An iterable of ``Module`` instances.
|
|
"""
|
|
return self.modules.values()
|
|
|
|
def get_module_list(self) -> list[str]:
|
|
"""
|
|
Return the list of module import paths.
|
|
|
|
Returns:
|
|
A list containing the dotted paths of all modules in the project.
|
|
"""
|
|
return list(self.modules.keys()) |