Skip to content
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.

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

Development: Fix documentation build warnings #7250

Merged
merged 2 commits into from
Sep 23, 2023
Merged

Conversation

b-fein
Copy link
Contributor

@b-fein b-fein commented Sep 23, 2023

Checklist

General

Motivation and Context

The documentation build produced some warnings.

Description

Fixes those warnings:

  • pyris: ymlyaml to fix code block syntax highlighting
  • cypress: remove trailing spaces to fix ‘unexpected indentation’ warning
  • setup: fix header underline length
  • mobile-applications: use an anonymous link (two underscores at the end) instead of a named one to resolve warning about duplicate link targets

Steps for Testing

Build the documentation locally with

cd docs
make clean
make html

Review Progress

Code Review

  • Code Review 1
  • Code Review 2

@Strohgelaender
Copy link
Contributor

Can we add a GitHub action that fails if such warnings exist? While I appreciate the effort, you should not need to constantly open PRs like this.

Copy link
Contributor

@Strohgelaender Strohgelaender left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@krusche krusche merged commit fc57413 into develop Sep 23, 2023
7 checks passed
@krusche krusche deleted the docs-build-fix-warnings branch September 23, 2023 15:18
@krusche krusche added this to the 6.5.2 milestone Sep 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants