How to configure .gitignore when using auto-generated content #12221
Unanswered
grant-allan-ctct
asked this question in
Q&A
Replies: 1 comment
-
In general, it isn't best practice with static site generators to commit built and/or auto-generated content to the repo, they get built and deployed as part of a continuous deployment pipeline. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hello, I am wondering if there is some official guidance on what to put in .gitignore when using modern-day Sphinx with a Python project?
I'm just getting started with Sphinx and it looks great already, by the way!!
I have looked at the documentation here and it mentions to push "everything under
docs/source
" to the repo.But I see that I currently have a
generated
folder in mydocs/source
folder and I am curious about whether that one (which I presume got built for me by one of the Sphinx extensions that I have tried out - eithersphinx.ext.autodoc
orsphinx.ext.autosummary
) maybe should not be added to the repo?I also see a
_static
and_templates
folder in mydocs/source
folder, both which are empty folders. Is it best to push those to the repo, or is the leading underscore a hint that it contains transient content and is not something to be version-controlled? In looking at myconf.py
file, I can see them both mentioned in there, but I confess to not knowing what they are:Many thanks for your advice!
Beta Was this translation helpful? Give feedback.
All reactions