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

BUG: Documentation build fails due to type cross-reference #366

Open
michaelcdevin opened this issue Aug 2, 2024 · 0 comments
Open

BUG: Documentation build fails due to type cross-reference #366

michaelcdevin opened this issue Aug 2, 2024 · 0 comments
Labels
bug Something isn't working CI Continuous integration (and development) documentation Improvements or additions to documentation

Comments

@michaelcdevin
Copy link
Collaborator

Describe the bug
Newer versions of sphinx return the following warning for all public methods in wecopttool.pto:

C:\code\WecOptTool\docs\source\api_docs\wecopttool.pto.PTO.acceleration.rst:2: WARNING: more than one target found for cross-reference 'WEC': wecopttool.WEC, wecopttool.core.WEC [ref.python]`

This warning is causing GitHub Actions documentation build to fail

Possibly related to sphinx-doc/sphinx#4961, though this issue is ~6 years old, and the problem with WecOptTool has only appeared recently.

To Reproduce
Run python docs/build_docs.py locally from the WecOptTool root with Sphinx >=7.0

Expected behavior
WecOptTool documentation builds successfully

Observed behavior
Build outputs many warnings similar to above, which aborts the documentation build

System:

  • OS: Windows 11
  • Python version: 3.11.9
  • WecOptTool version: 3.0.1
  • Any other relevant package version: Sphinx >= 7.0
@michaelcdevin michaelcdevin added bug Something isn't working documentation Improvements or additions to documentation CI Continuous integration (and development) labels Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working CI Continuous integration (and development) documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant