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 build warnings #962

Merged
merged 3 commits into from
Apr 29, 2024

Conversation

pboushy
Copy link
Contributor

@pboushy pboushy commented Apr 24, 2024

This PR resolves all the below warnings experienced during make html:

/Users/pboushy/excl/git-repos/openfl/docs/about/features.rst:6: WARNING: Duplicate explicit target name: "for more info".
/Users/pboushy/excl/git-repos/openfl/docs/about/features.rst:6: WARNING: Duplicate explicit target name: "for more info".
/Users/pboushy/excl/git-repos/openfl/docs/about/features.rst:6: WARNING: Duplicate explicit target name: "for more info".
/Users/pboushy/excl/git-repos/openfl/docs/about/features.rst:6: WARNING: Duplicate explicit target name: "for more info".
/Users/pboushy/excl/git-repos/openfl/docs/about/releases.md:24: WARNING: duplicate label about/releases:highlights, other instance in /Users/pboushy/excl/git-repos/openfl/docs/about/releases.md
/Users/pboushy/excl/git-repos/openfl/docs/developer_guide/experimental_features.rst:25: WARNING: toctree contains reference to nonexisting document 'developer_guide/workflow_interface'
/Users/pboushy/excl/git-repos/openfl/docs/get_started/examples.rst:42: WARNING: Title overline too short.

-------------------------
Workflow Interface (Experimental)
-------------------------
/Users/pboushy/excl/git-repos/openfl/docs/get_started/examples.rst:42: WARNING: Title overline too short.

-------------------------
Workflow Interface (Experimental)
-------------------------
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/pboushy/excl/git-repos/openfl/docs/README.md: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/about/features_index/pynative.rst: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/about/overview.how_can_intel_protect_federated_learning.rst: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/about/overview.what_is_intel_federated_learning.rst: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/developer_guide/running_the_federation.singularity.rst: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/get_started/install.singularity.rst: WARNING: document isn't included in any toctree
/Users/pboushy/excl/git-repos/openfl/docs/structurizer_dsl/README.md: WARNING: document isn't included in any toctree

NOTE - please double check the exclusion of README.md files from conf.py - they do not appear to be necessary for the website, but I was not certain.

@pboushy pboushy force-pushed the fix-sphinx-build-warnings branch from ee9a163 to 7f31a17 Compare April 24, 2024 22:28
@psfoley psfoley self-requested a review April 24, 2024 23:00
@psfoley
Copy link
Contributor

psfoley commented Apr 24, 2024

Thanks so much for the fixes, @pboushy. I'll test this locally in the next day and approve if everything looks good.

@psfoley psfoley merged commit 49632d1 into securefederatedai:develop Apr 29, 2024
25 of 26 checks passed
manuelhsantana pushed a commit that referenced this pull request Jul 10, 2024
* Fix all warnings related to broken links

Signed-off-by: Phillip Boushy <[email protected]>

* Suppress "not included in any toctree warnings" for TODO pages.

Signed-off-by: Phillip Boushy <[email protected]>

* Header lines must be as long as the header text

Signed-off-by: Phillip Boushy <[email protected]>

---------

Signed-off-by: Phillip Boushy <[email protected]>
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.

2 participants