From 20b917040f3613cff329501feac981b0d5fb8c91 Mon Sep 17 00:00:00 2001 From: erseco Date: Wed, 8 Jul 2026 03:37:14 +0100 Subject: [PATCH] docs: title the site python-moodle and drop the py_moodle.* API headings The docs showed 'py_moodle' in two places that read as titles: - the site header / browser tab used site_name 'py-moodle'; - every API reference page rendered a redundant 'py_moodle.' heading (mkdocstrings show_root_heading with the full module path), right under the page's own nice title (e.g. 'Course'). Fix both: - site_name -> 'python-moodle' (matches the PyPI/GitHub project name). - mkdocstrings: show_root_heading=false + show_root_full_path=false and heading_level=2, so each API page keeps its clean '# Course' title with members nested underneath and no 'py_moodle.course' heading. The 'py_moodle' string now only survives as invisible anchor ids. Verified with a local mkdocs build: api/course renders 'Course' (h1) -> Attributes/Classes/Functions (h2) -> create_course etc. (h3), and the browser title is 'Course - python-moodle'. --- mkdocs.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 02cc2be..650bab1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: py-moodle +site_name: python-moodle site_description: A modern Pythonic CLI and library to manage Moodle via web sessions site_author: Ernesto Serrano site_url: https://erseco.github.io/python-moodle/ @@ -74,11 +74,12 @@ plugins: docstring_section_style: table filters: - '!^_' - heading_level: 1 + heading_level: 2 inherited_members: true merge_init_into_class: true separate_signature: true - show_root_heading: true + show_root_heading: false + show_root_full_path: false show_signature_annotations: true show_source: false signature_crossrefs: true