docs: title the site 'python-moodle' and remove py_moodle.* API headings#82
Merged
Conversation
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.<module>' 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'.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the documentation showing
py_moodleas a title. It appeared in two spots: the site header/tab (site_name: py-moodle) and, more prominently, a redundantpy_moodle.<module>heading on every API reference page (mkdocstrings rendering the fully-qualified module path under each page's own title).Changes (
mkdocs.ymlonly)site_name: py-moodle→python-moodle(matches the PyPI/GitHub project name; header + browser tab).show_root_heading: false,show_root_full_path: false,heading_level: 2— so each API page keeps its clean# Coursetitle with members nested below, and nopy_moodle.courseheading.Verification
Local
mkdocs build(reads the samemkdocs.ymlas Zensical):api/courserendersCourse(h1) →Attributes/Classes/Functions(h2) →create_course/MoodleCourseError/... (h3). No visiblepy_moodle.text (it survives only as invisible anchorid=s).Course - python-moodle(wasCourse - py-moodle); home pagepython-moodle.Notes for reviewers
py-moodle(hyphen) remains the CLI command name and the logo brand — only the documentation site title and API headings changed. If you'd rather keeppy-moodleas the site header brand, revert just thesite_nameline; the mkdocstrings heading fix stands on its own.