Skip to content

update the clone step in the installation guide to include submodules #5408

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

Closed
agarwalrounak opened this issue Mar 6, 2019 · 2 comments
Closed
Labels
Good First Issue Good for new contributors Needed: documentation Documentation is required

Comments

@agarwalrounak
Copy link
Contributor

Details

When running the pre-commit command pre-commit run, it gives the error that .pre-commit-config.yaml does not exist though the command ls -a clearly mentions that .pre-commit-config.yaml exists.

Actual Result

screenshot from 2019-03-07 01-23-19

@stsewd
Copy link
Member

stsewd commented Mar 6, 2019

You are missing the submodule.

git submodule update --init

We should update the clone step in the installation guide to include submodules.

https://docs.readthedocs.io/en/stable/install.html#get-and-run-read-the-docs

@stsewd stsewd added Good First Issue Good for new contributors Needed: documentation Documentation is required labels Mar 6, 2019
@stsewd stsewd changed the title .pre-commit-config.yaml does not exist update the clone step in the installation guide to include submodules Mar 6, 2019
@agarwalrounak
Copy link
Contributor Author

@stsewd Thanks for the prompt reply :) I will send a PR with the required changes soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for new contributors Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

2 participants