changeset 265:e5ea2f955986

Optimize documentation layout: use a local ToC where appropriate (lexers, filters)
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 19 May 2026 18:50:24 +0200
parents 3dce08f06ecc
children 50bd1e91b822
files docs/conf.py docs/filters.rst docs/index.rst docs/lexer-algpseudocode.rst docs/lexers.rst
diffstat 5 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Tue May 19 18:37:32 2026 +0200
+++ b/docs/conf.py	Tue May 19 18:50:24 2026 +0200
@@ -126,7 +126,7 @@
 html_static_path = ['_static']
 html_extra_path = ['../LICENSES']
 html_copy_source = True
-html_show_sourcelink = False
+html_show_sourcelink = False  # place a manual link on some selected pages only
 #html_sidebars = {
 #    '**': [
 #        'localtoc.html',     # a fine-grained table of contents of the
--- a/docs/filters.rst	Tue May 19 18:37:32 2026 +0200
+++ b/docs/filters.rst	Tue May 19 18:50:24 2026 +0200
@@ -4,6 +4,10 @@
  Filters
 *********
 
+.. only:: html
+
+   .. contents::          
+
 The package contains the following filters:
 
 .. raw:: latex
--- a/docs/index.rst	Tue May 19 18:37:32 2026 +0200
+++ b/docs/index.rst	Tue May 19 18:50:24 2026 +0200
@@ -6,7 +6,7 @@
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Site Contents:
 
    lexers
    filters
--- a/docs/lexer-algpseudocode.rst	Tue May 19 18:37:32 2026 +0200
+++ b/docs/lexer-algpseudocode.rst	Tue May 19 18:50:24 2026 +0200
@@ -7,6 +7,10 @@
 
 .. only:: html
 
+   .. contents::          
+
+.. only:: html
+
    .. hint::
       The reST source of this documentation page can be found
       `here <_sources/lexer-algpseudocode.rst.txt>`_.
--- a/docs/lexers.rst	Tue May 19 18:37:32 2026 +0200
+++ b/docs/lexers.rst	Tue May 19 18:50:24 2026 +0200
@@ -5,6 +5,7 @@
 ********
 
 .. toctree::
+   :maxdepth: 1
 
    lexer-algpseudocode
    lexer-frpseudocode