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

Error in get_outdated_docs when framents dir missing #84

Open
jaraco opened this issue Jun 21, 2023 · 4 comments
Open

Error in get_outdated_docs when framents dir missing #84

jaraco opened this issue Jun 21, 2023 · 4 comments
Labels
bug Something isn't working good first issue Good for newcomers hacktoberfest-accepted Confirmation that the PR is legit for Hacktoberfest help wanted Extra attention is needed

Comments

@jaraco
Copy link
Contributor

jaraco commented Jun 21, 2023

Towncrier runs fine if the newsfragments directory doesn't exist.

This plugin will fail if the directory doesn't exist with this error:

Extension error (sphinxcontrib.towncrier.ext):
Handler <bound method TowncrierDraftEntriesEnvironmentCollector.get_outdated_docs of <sphinxcontrib.towncrier.ext.TowncrierDraftEntriesEnvironmentCollector object at 0x1075c3990>> for event 'env-get-outdated' threw an exception (exception: Failed to list the news fragment files.
FileNotFoundError: [Errno 2] No such file or directory: '../newsfragments/'
)

This plugin should honor the degenerate newsfragments including no directory, same as towncrier.

@webknjaz
Copy link
Member

Fair enough. This needs to be fixed.

@webknjaz webknjaz added bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed hacktoberfest-accepted Confirmation that the PR is legit for Hacktoberfest labels Jun 21, 2023
@adkbbx
Copy link

adkbbx commented Sep 26, 2023

Hey there, I'm intersted in contributing to this issue do let me know how I can help

@webknjaz
Copy link
Member

@adkbbx just need to figure out where to suppress the exception and the side effects of doing so.

@jaraco
Copy link
Contributor Author

jaraco commented Oct 25, 2023

Apologies for not linking to a project that has this issue. To reproduce, you'll want to set up a sphinx docs using get_outdated_docs and then build the docs. Here's one project that's using that setting. The rest of the settings can probably be left at the defaults. Let me know if that's not enough to reproduce the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers hacktoberfest-accepted Confirmation that the PR is legit for Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants