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

mkdocs not automatically installed #80

Open
adelavega opened this issue Mar 2, 2021 · 4 comments
Open

mkdocs not automatically installed #80

adelavega opened this issue Mar 2, 2021 · 4 comments

Comments

@adelavega
Copy link

In my project, I don't have a requirements.txt files at the top level, as the project has multiple non python components.

As a consequence, this GH Action did not find my requirement file and in turn did not install mkdocs.

This was easy to resolve for me, but IMO it would make more sense if this action installed mkdocs even if no requirements.txt file is found.

@mhausenblas
Copy link
Owner

I'm not sure I'm following, which branch did you use @adelavega?

@adelavega
Copy link
Author

adelavega commented Mar 2, 2021

I used nomaterial. What I mean is that if you do not have a mkdocs in your project's top level requirements.txt file, you'll get the following error:

/action.sh: line 53: mkdocs: command not found

IMO, the action should install mkdocs without having to specify this in your project's requirements.txt file, as that is not a requirement of the project, but only the docs.
Also, in my situation where I have the main python project under a subfolder, I needed to put a requirements.txt file just to list mkdocs , for it to be installed. An easy workaround, but ideally this shouldn't be necessary.

Thanks!

@mhausenblas
Copy link
Owner

Thanks for clarifying @adelavega! I see. WDYT @janoszen?

@ghost
Copy link

ghost commented Mar 2, 2021

We should probably install mkdocs in the action.

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