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

Fix sphinx warnings #2721

Merged
merged 3 commits into from Dec 19, 2023
Merged

Fix sphinx warnings #2721

merged 3 commits into from Dec 19, 2023

Conversation

Robert-Steiner
Copy link
Member

Issue

When building the documentation locally, some warnings appear. This pr fixes two of the 4 warnings.

Description

Warning 1:

checking consistency... /project/flower_github/doc/source/contributor-how-create-new-messages.rst: WARNING: document isn't included in any toctree

Fixed by renaming the filename.

Warning 2

/project/flower_github/src/py/flwr/simulation/app.py:docstring of flwr.simulation.app.start_simulation:24: WARNING: Inline interpreted text or phrase reference start-string without end-string.

Fixed by having no the line break within the backticks.

Related issues/PRs

Proposal

Explanation

Checklist

  • Implement proposed change
  • Write tests
  • Update documentation
  • Update changelog
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Any other comments?

@danieljanes danieljanes enabled auto-merge (squash) December 19, 2023 18:43
@danieljanes danieljanes merged commit c078d3a into main Dec 19, 2023
27 checks passed
@danieljanes danieljanes deleted the fix-missing-page branch December 19, 2023 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants