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

Transform project name to fix ReadTheDocs link #427

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

camposandro
Copy link
Contributor

@camposandro camposandro commented Feb 14, 2024

ReadTheDocs does not support project names with underscores. This transforms underscores to hyphens so we can generate a valid link (thanks @delucchi-cmu for the suggested change) . Closes #421.

Checklist

  • This PR is meant for the lincc-frameworks/python-project-template repo and not a downstream one instead.
  • This change is linked to an open issue
  • This change includes integration testing, or is small enough to be covered by existing tests

@camposandro camposandro self-assigned this Feb 14, 2024
Copy link
Collaborator

@drewoldag drewoldag left a comment

Choose a reason for hiding this comment

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

Thanks!

@camposandro camposandro merged commit 6f69d3d into main Feb 14, 2024
13 checks passed
@camposandro camposandro deleted the issue/421/fix-badges-with-underscores branch February 14, 2024 19:17
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.

project_name question permits underscores, but readthedocs does not
3 participants