Skip to content

Update .gitignore to include _build/ folder from docs/source #8911

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

Merged
merged 1 commit into from
Jun 8, 2020

Conversation

ChetanKhanna
Copy link
Contributor

While sending a PR for a documentation update I noticed an untracked docs/source/_build/ folder, containing html files for the documentation. I added the same to gitignore so to avoid them getting pushed mistakenly.

@TH3CHARLie
Copy link
Collaborator

I am curious about how you compile/generate the HTML files, would you mind sharing the commands you run?

@ChetanKhanna
Copy link
Contributor Author

I didn't run any particular command other than the usual git commands after making the changes. The only thing unusual was probably a sphinx popup on my vs code editor while opening the rst file which I might have clicked 🤔
Unfortunately I don't have any knowledge of sphinx so I don't have any further details

@TH3CHARLie
Copy link
Collaborator

TH3CHARLie commented May 28, 2020

I didn't run any particular command other than the usual git commands after making the changes. The only thing unusual was probably a sphinx popup on my vs code editor while opening the rst file which I might have clicked 🤔
Unfortunately I don't have any knowledge of sphinx so I don't have any further details

What I originally mean is that, for usual cases, people build docs by:

cd docs
make html

Following this workflow usually doesn't generate anything that hasn't been git-ignored. In your cases, I bet the docs/source/_build folder is generated by vscode plugin.

@ChetanKhanna
Copy link
Contributor Author

What I originally mean is that, for usual cases, people build docs by:

cd docs
make html

Following this workflow usually doesn't generate anything that hasn't been git-ignored. In your cases, I bet the docs/source/_build folder is generated by vscode plugin.

Agreed since I never executed these commands.

@JukkaL
Copy link
Collaborator

JukkaL commented Jun 8, 2020

Ignoring this directory seems no big deal even if it's not necessary when using the official workflow.

@JukkaL JukkaL merged commit fe216a3 into python:master Jun 8, 2020
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

Successfully merging this pull request may close these issues.

3 participants