From 115060b76246f62cc9ec30f017aa2108a827b9d9 Mon Sep 17 00:00:00 2001 From: Jaapio Date: Mon, 5 Jan 2026 22:45:19 +0100 Subject: [PATCH] Improve doc titles --- docs/how-to/adding-your-own-tag.rst | 2 +- docs/how-to/index.rst | 2 +- docs/how-to/interpreting-a-simple-docblock.rst | 2 +- docs/how-to/interpreting-tags.rst | 2 +- docs/how-to/reconstituting-a-docblock.rst | 2 +- docs/index.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/how-to/adding-your-own-tag.rst b/docs/how-to/adding-your-own-tag.rst index 64464d8..7ff1d4a 100644 --- a/docs/how-to/adding-your-own-tag.rst +++ b/docs/how-to/adding-your-own-tag.rst @@ -1,4 +1,4 @@ -How to Add Your Own Tag +Add Your Own Tag ======================= This guide demonstrates how to add your own custom tag to a DocBlock using ReflectionDocBlock. diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 3f90b0a..377f5df 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -1,4 +1,4 @@ -How-to Guides +How-to ============= Practical guides for common tasks with ReflectionDocBlock: diff --git a/docs/how-to/interpreting-a-simple-docblock.rst b/docs/how-to/interpreting-a-simple-docblock.rst index b537c90..d2d8fd3 100644 --- a/docs/how-to/interpreting-a-simple-docblock.rst +++ b/docs/how-to/interpreting-a-simple-docblock.rst @@ -1,4 +1,4 @@ -How to Interpret a Simple DocBlock +Interpret a Simple DocBlock ================================== This guide demonstrates how to parse a simple DocBlock and extract its summary and description using ReflectionDocBlock. diff --git a/docs/how-to/interpreting-tags.rst b/docs/how-to/interpreting-tags.rst index fdea6f6..916b92a 100644 --- a/docs/how-to/interpreting-tags.rst +++ b/docs/how-to/interpreting-tags.rst @@ -1,4 +1,4 @@ -How to Interpret Tags in a DocBlock +Interpret Tags in a DocBlock =================================== This guide demonstrates how to interpret tags within a DocBlock using ReflectionDocBlock. diff --git a/docs/how-to/reconstituting-a-docblock.rst b/docs/how-to/reconstituting-a-docblock.rst index cade578..84ed201 100644 --- a/docs/how-to/reconstituting-a-docblock.rst +++ b/docs/how-to/reconstituting-a-docblock.rst @@ -1,4 +1,4 @@ -How to Reconstitute a DocBlock +Reconstitute a DocBlock ============================== ReflectionDocBlock not only allows you to read and interpret DocBlocks, but also to reconstruct them. This is useful if you need to add, remove, or modify tags in your codebase programmatically. diff --git a/docs/index.rst b/docs/index.rst index 6ac3482..e59d9d2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,7 @@ For more detailed usage and how-to guides, see the ``examples/`` directory. .. toctree:: :maxdepth: 2 - :caption: Contents: + :hidden: installation how-to/index