Skip to content

Add singlerst builder (single-file reStructuredText output) #36

@jdillard

Description

@jdillard

A useful addition would be a singlerst builder analogous to Sphinx’s core singlehtml builder. The goal is to produce a single concatenated reStructuredText file containing the entire documentation tree, preserving section structure but without splitting it into multiple files.

This would be useful in generating a single-file reST version of a docs project that can be used for llms-full.txt. The main reason being, converting reStructuredText to markdown for the llms-full.txt isn't a 1:1 relationship as markdown is more simple, so this could help maintain clarity.

An example of using the restbuilder for LLM text files can be seen in this PR: jdillard/sphinx-llms-txt#53

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions