ContextMaker

Contents:

  • Introduction
    • What is ContextMaker?
    • Key Features
    • Use Cases
    • Acknowledgments
    • Quick Start
  • Usage Guide
    • Installation
    • Command Line Interface (CLI)
      • Basic Usage
      • Advanced Usage
    • Python API
    • Supported Input Formats
      • Sphinx Documentation
      • Markdown Files
      • Jupyter Notebooks
      • Python Source Code
    • Output Format
      • Example Output Structure
    • Markdown Builder Tool
      • Usage
  • Examples
    • Converting Sphinx Documentation
      • Example 1: Basic Sphinx Project
      • Example 2: Sphinx with Custom Configuration
    • Converting Jupyter Notebooks
      • Example 3: Notebook Collection
    • Converting Source Code
      • Example 4: Python Package with Docstrings
    • Converting Mixed Content
      • Example 5: Project with Multiple Documentation Types
    • Using the Markdown Builder Directly
      • Example 6: Custom Sphinx to Markdown Conversion
      • Example 7: Including Notebooks in Sphinx Build
    • Python API Examples
      • Example 8: Programmatic Usage
      • Example 9: Using Individual Converters
      • Example 10: Custom Markdown Processing
  • API Reference
    • Main Module
    • Converters
      • Auxiliary Functions
        • convert_markdown_to_txt()
        • find_format()
        • has_docstrings()
        • has_documentation()
        • has_notebook()
        • has_source()
      • Sphinx Converter
      • Non-Sphinx Converter
      • Markdown Builder
        • append_notebook_markdown()
        • build_markdown()
        • combine_markdown()
        • convert_notebook()
        • extract_toctree_order()
        • main()
        • parse_args()
    • Command Line Interface
    • Arguments
    • Markdown Builder CLI
    • Arguments
    • Examples
      • Basic Sphinx Conversion
      • Source Code Conversion
      • Notebook Conversion
  • contextmaker
    • contextmaker package
      • Submodules
      • contextmaker.contextmaker module
      • Module contents
  • contextmaker package
    • Submodules
    • contextmaker.contextmaker module
    • Module contents
ContextMaker
  • Search

© Copyright 2025, Chadi Ait Ekioui.

Built with Sphinx using a theme provided by Read the Docs.