Use first paragraph as summary by default (#22)

2025-06-22 21:00:40 -07:00
parent b56d93d265
commit 46c2dec254
7 changed files with 120 additions and 12 deletions
@@ -146,7 +146,7 @@ Integration Examples
 Complete Configuration Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-Here's a complete example showing multiple :ref:`configuration-values`:
+Here's a complete example showing multiple :doc:`configuration-values`:

 .. code-block:: python

@@ -67,8 +67,8 @@ Project Configuration Values

 .. confval:: llms_txt_summary

-   - **Type**: string or ``None``
-   - **Default**: ``None``
+   - **Type**: string
+   - **Default**: The first paragraph in the root document, else an empty string
   - **Description**: Optional, but recommended, summary description for ``llms.txt``.
     See :ref:`custom_summary`.

@@ -31,7 +31,7 @@ Once added, the extension will automatically generate the LLMs.txt files during
 See :doc:`advanced-configuration` for more information about how to use **sphinx-llms-txt**.

 How It Works
-----------
+------------

 During the Sphinx build process: