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 test" errors #195

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Fix "sphinx-build test" errors #195

merged 2 commits into from
Jun 21, 2023

Conversation

djjuhasz
Copy link
Member

@djjuhasz djjuhasz commented Jun 9, 2022

sphinx-build test throws an error in Sphinx v5 because the extlinks
definitions don't include an explicit %s character in the "caption".

  • Add a local "links/" directory and "link.py" file for extlink
    definitions
  • Update extlink "captions" to include a "%s" placeholder
  • Update config.py to use local extlink definitions
  • Add "make checklinks" script to generate a report of dead links
  • Update conf.py and .gitignore to ignore a venv ".env" directory
  • Add ".vscode" and "pycache dirs to .gitignore
  • Cosmetic: reformatted conf.py with black

@djjuhasz djjuhasz force-pushed the dev/fix-build-warnings branch 2 times, most recently from d16b75a to 3e9923d Compare June 9, 2022 23:03
`sphinx-build test` throws an error in Sphinx v5 because the extlinks
definitions don't include an explicit %s character in the "caption".

- Add a local "links/" directory and "link.py" file for extlink
  definitions
- Update extlink "captions" to include a "%s" placeholder
- Update config.py to use local extlink definitions
- Update conf.py and .gitignore to ignore a venv ".env" directory
- Add ".vscode" and "__pycache__ dirs to .gitignore
- Cosmetic: reformatted conf.py with black
@djjuhasz djjuhasz force-pushed the dev/fix-build-warnings branch 2 times, most recently from 42f1a6b to 1d0a1be Compare June 11, 2022 00:23
@anvit
Copy link
Contributor

anvit commented Jun 20, 2023

@djjuhasz I just added a new definition to extlinks for AtoM Github issues but the rest looks good to me!

The test does still fail since it looks like we have a bunch of undefined labels in the repo, but I confirmed that this fix works and the test passes once those labels are fixed. Will make a PR to fix those labels shortly.

@djjuhasz djjuhasz self-assigned this Jun 20, 2023
@djjuhasz
Copy link
Member Author

@anvit great! If you approved the PR, I'll merge it. :)

Copy link
Contributor

@anvit anvit left a comment

Choose a reason for hiding this comment

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

Looks good!

@djjuhasz djjuhasz merged commit 47a2352 into 2.7 Jun 21, 2023
0 of 2 checks passed
@anvit anvit deleted the dev/fix-build-warnings branch October 23, 2023 23:42
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