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

Add debug option for building documentation locally #374

Merged
merged 2 commits into from
Oct 10, 2024

Conversation

michaelcdevin
Copy link
Collaborator

Description

Resolves #373. The default build option when calling docs/build_docs.py is debug, which only builds the documentation for the git branch you are currently on. Calling python docs/build_docs.py --build production will create multiple versions of the documentation as per #347, and is called in the GitHub CI workflows

Type of PR

  • Bug fix
  • New feature
  • Documentation
  • Other: (specify)

Checklist for PR

@michaelcdevin michaelcdevin added bug Something isn't working documentation Improvements or additions to documentation labels Oct 9, 2024
@michaelcdevin michaelcdevin self-assigned this Oct 9, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 11258563446

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 94.514%

Totals Coverage Status
Change from base Build 11237041950: 0.0%
Covered Lines: 2774
Relevant Lines: 2935

💛 - Coveralls

@ryancoe
Copy link
Collaborator

ryancoe commented Oct 10, 2024

This looks good to me, please go ahead and merge

@michaelcdevin michaelcdevin merged commit 0ed4704 into sandialabs:dev Oct 10, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants