Skip to content

Shared docs: fix sphinx-build warnings #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: shared-docs
Choose a base branch
from
Open

Shared docs: fix sphinx-build warnings #58

wants to merge 4 commits into from

Conversation

barsnick
Copy link
Contributor

These caused the linkchecker workflow action to fail:

[sphinx-action] Running: ['sphinx-build', '-b', 'linkcheck', 'source/', 'build/', '--keep-going', '--no-color', '-w', '/tmp/sphinx-log']
Warning: Title underline too short.
Warning: Title underline too short.
Warning: Duplicate explicit target name: "rauc".
[sphinx-action] Build failed with 3 warnings

See https://github.com/chargebyte/chargebyte-docs/actions/runs/15925155705/job/44920634152

Also clean up some URLs.

barsnick added 4 commits July 10, 2025 09:50
@barsnick
Development: fix underline length
127d5ef 
Fixes this sphinx-build warning:
  includes/development_creating_fw_images.inc:67: WARNING: Title underline too short.

  Integrating a Custom EVerest Module
  -------------------------------

Signed-off-by: Moritz Barsnick <[email protected]>
@barsnick
Firmware: make one RAUC reference anonymous
3eac4d0 
This does not affect the formatting of the output or the links.

Fixes this sphinx-build warning:
  includes/firmware_upgrade.inc:3: WARNING: Duplicate explicit target name: "rauc".

Signed-off-by: Moritz Barsnick <[email protected]>
@barsnick
CB energy: move link from nymea.energy to chargebyte.energy
720a3b0 
Signed-off-by: Moritz Barsnick <[email protected]>
@barsnick
Development/Firmware: avoid direct links to index.html pages
b3368f5 
Prefer "pure" links where they work.

Signed-off-by: Moritz Barsnick <[email protected]>
@barsnick barsnick requested review from mhei, lategoodbye and FaHaGit July 10, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhei mhei Awaiting requested review from mhei

@lategoodbye lategoodbye Awaiting requested review from lategoodbye

@FaHaGit FaHaGit Awaiting requested review from FaHaGit

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@barsnick