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.

Sign up for GitHub

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

Jump to bottom

Update .gitignore for new Sphinx output location #376

Open
ryancoe opened this issue Oct 11, 2024 · 0 comments
Open

Update .gitignore for new Sphinx output location #376

ryancoe opened this issue Oct 11, 2024 · 0 comments
Assignees
@ryancoe
Labels
clean-up Tidy up code, fix non-breaking problems documentation Improvements or additions to documentation

Comments

@ryancoe
Copy link
Collaborator

ryancoe commented Oct 11, 2024

With #356 (and likely some underlying PR?), we started moving the HTML results from build_docs.py to docs/pages/ in addition to docs/_build

WecOptTool/docs/build_docs.py

Line 78 in b9e1e0d

shutil.copytree(html_dir, os.path.join(docs_dir, 'pages'))

We should therefore update the following section of .gitignore to ignore the build_docs.py output.

WecOptTool/.gitignore

Lines 8 to 11 in b9e1e0d

# Sphinx
docs/_build/
docs/source/_examples
docs/source/api_docs

Action: update .gitignore so that we don't see all of the docs build artifacts showing up as git changes.
@ryancoe ryancoe added documentation Improvements or additions to documentation clean-up Tidy up code, fix non-breaking problems labels Oct 11, 2024
@ryancoe ryancoe mentioned this issue Oct 11, 2024
Open
@ryancoe ryancoe assigned ryancoe and unassigned jtgrasb Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ryancoe ryancoe

Labels
clean-up Tidy up code, fix non-breaking problems documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ryancoe @jtgrasb