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

Conform to expectations regarding directories for docs and for test-data #13

Open
dalito opened this issue Jan 21, 2025 · 0 comments
Open
Labels
enhancement New feature or request
Milestone

Comments

@dalito
Copy link
Owner

dalito commented Jan 21, 2025

The template inherited a slightly unconventional directory layout from linkml-project-cookiecutter.

In most python and many other projects, some files are stored at different locations. So the template breaks the expectations. We we should fix that.

  • Source files for the documentation are currently src/docs. We should move them to docs/. Note that docs/ is currently git-ignored as it is used as build-directory for the documentation. The new build dir should be docs/_build (need to check if this name is typical for mkdocs; it is for sphinx).

  • Test data used in unit tests are currently in src/data/examples/ but typically stored under tests/....

@dalito dalito added the enhancement New feature or request label Jan 21, 2025
@dalito dalito added this to the Release 0.2.0 milestone Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant