Skip to content

Task: strictdoc.toml: include_doc_paths: review the path masks, accept underscore character #2211

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

Open
stanislaw opened this issue May 2, 2025 · 1 comment

Comments

@stanislaw
Copy link
Collaborator

error: strictdoc.toml: 'include_doc_paths': Path mask must start with an alphanumeric character or a wildcard symbol ''. Provided string: '_assets/'.

I will double-check this today. Relaxing the condition to accept underscores should be easy. I will create an integration test to exercise this case.

Originally posted by @stanislaw in #2210

@stanislaw
Copy link
Collaborator Author

stanislaw commented May 2, 2025

@johanenglund just to make sure:

This is what StrictDoc itself uses and I don't need to explicitly specify the asset folders:

include_doc_paths = [
  "docs/**",
  "docs_extra/**",
  "reports/**",
]

The assets are inside docs: https://github.com/strictdoc-project/strictdoc/tree/main/docs/_assets.

Is your setup more custom in some way?

@stanislaw stanislaw added this to the 2025-Q2 milestone May 2, 2025
@stanislaw stanislaw modified the milestones: 2025-Q2, 2025-Q3 Jun 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant