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

Docs Fix #393

Merged
merged 6 commits into from
Apr 15, 2024
Merged

Docs Fix #393

merged 6 commits into from
Apr 15, 2024

Conversation

atharva-2001
Copy link
Member

📝 Description

Type: 📝 documentation | 🎢 infrastructure

Docs workflow is failing with this traceback-

sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v5.3.0

Exception occurred:
  File "/home/runner/micromamba/envs/carsus/lib/python3.7/site-packages/numpydoc/__init__.py", line 10, in setup
    from .numpydoc import setup
  File "/home/runner/micromamba/envs/carsus/lib/python3.7/site-packages/numpydoc/numpydoc.py", line 221
    overrides := app.config.numpydoc_validation_overrides.get(
              ^
SyntaxError: invalid syntax
The full traceback has been saved in /tmp/sphinx-err-dmi60mvz.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:44: html] Error 2

because numpydoc had a recent release (1.6.0) which used the walrus operator in the code which is not compatible with our pinned python dependency. Pinning numpydoc to a previous release fixes this. This PR also updates the lock files corresponding to this change.

📌 Resources

See numpydoc releases here-
https://github.com/numpy/numpydoc/releases

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@atharva-2001
Copy link
Member Author

atharva-2001 commented Apr 12, 2024

Successful docs workflow- atharva-2001#3
https://atharva-2001.github.io/carsus/pull/3/

The URL thing has been fixed in this PR.

Copy link
Contributor

@andrewfullard andrewfullard left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up! Great work.

@andrewfullard andrewfullard requested a review from afloers April 12, 2024 17:19
@KasukabeDefenceForce
Copy link
Contributor

It looks good to me.

@andrewfullard andrewfullard merged commit 1fb3256 into tardis-sn:master Apr 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants