vrr/open-notebook
2
0
Fork 0
mirror of https://github.com/lfnovo/open-notebook.git synced 2026-07-10 00:12:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
open-notebook/scripts
History
Exact
krataratha 238e8e925d
Enhance export_docs.py with Table of Contents feature (#865) 
* Enhance export_docs.py with Table of Contents feature

Added a Table of Contents generation feature to the documentation export script, enhancing navigation through consolidated markdown files.

* fix: remove duplicated orphaned code from export_docs.py

The TOC change accidentally duplicated consolidate_folder/main and left
the old body orphaned after the __main__ guard, causing an IndentationError.
Keep only the intended TOC generation so the script runs again.

---------

Co-authored-by: Luis Novo <lfnovo@gmail.com>
2026-06-13 08:52:26 -03:00
..
export_docs.py Enhance export_docs.py with Table of Contents feature (#865) 2026-06-13 08:52:26 -03:00
README.md chore: export docs for custom gpt 2025-10-18 20:26:11 -03:00
wait-for-api.sh fix(docker): make wait-for-api.sh POSIX and enforce LF line endings (#586) (#598) 2026-04-19 15:49:11 -03:00

README.md

Scripts Documentation

export_docs.py

Consolidates markdown documentation files for use with ChatGPT or other platforms with file upload limits.

What It Does

  • Scans all subdirectories in the docs/ folder
  • For each subdirectory, combines all .md files (excluding index.md files)
  • Creates one consolidated markdown file per subdirectory
  • Saves all exported files to doc_exports/ in the project root

Usage

# Using Makefile (recommended)
make export-docs

# Or run directly with uv
uv run python scripts/export_docs.py

# Or run with standard Python
python scripts/export_docs.py

Output

The script creates doc_exports/ directory with consolidated files like:

  • getting-started.md - All getting-started documentation
  • user-guide.md - All user guide content
  • features.md - All feature documentation
  • development.md - All development documentation
  • etc.

Each exported file includes:

  • A main header with the folder name
  • Section headers for each source file
  • Source file attribution
  • The complete content from each markdown file
  • Visual separators between sections

Example Output Structure

# Getting Started

This document consolidates all content from the getting-started documentation folder.

---

## Installation

*Source: installation.md*

[Full content of installation.md]

---

## Quick Start

*Source: quick-start.md*

[Full content of quick-start.md]

---

Notes

  • The doc_exports/ directory is gitignored and safe to regenerate anytime
  • Index files (index.md) are automatically excluded
  • Files are sorted alphabetically for consistent output
  • The script handles subdirectories only (ignores files in the root docs/ folder)