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

Generated mdakit reStructuredText files should be put in a subdirectory #49

Open
ianmkenney opened this issue May 2, 2023 · 3 comments

Comments

@ianmkenney
Copy link
Member

The generated Kit documentation is placed in the same directory as manually edited docs, such as about.rst. For development this only creates noise when it comes to version control as each new kit will add a new line in the "Untracked files". I suggest we have generated files put into a kits/ directory, which can then be put in the gitignore.

@IAlibay
Copy link
Member

IAlibay commented May 2, 2023

those files should be autogenerated - they shouldn't ever be kept around - edit: I think I see what you mean, just an empty kits folder?

@IAlibay IAlibay closed this as completed May 2, 2023
@IAlibay IAlibay reopened this May 2, 2023
@IAlibay
Copy link
Member

IAlibay commented May 2, 2023

(oops accidentally clicked on "close with comment")

@ianmkenney
Copy link
Member Author

Yes, when generating the files, the kit/ directory should be created. No need to keep the empty directory around in VC either, basically the same way the _build/ directory is treated which is explicitly in the gitignore.

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

No branches or pull requests

2 participants