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

Fix docs #50

Merged
merged 18 commits into from
Dec 10, 2024
Merged

Fix docs #50

merged 18 commits into from
Dec 10, 2024

Conversation

mcocdawc
Copy link
Contributor

@mcocdawc mcocdawc commented Dec 9, 2024 •
edited
Loading

  • added improvements to the documentation, such as links to external libraries
  • Fixed the broken links in the documentation
  • actually fail the build when links are broken (this is shown in this build where I consciously added a broken link)
  • changed an assert into if-statement in src/quemb/molbe/misc.py, since it should also be there in production code

Fixes #5

mscho527
mscho527 requested changes Dec 10, 2024
View reviewed changes
docs/source/solvers.rst Show resolved Hide resolved
src/quemb/molbe/be_parallel.py Show resolved Hide resolved
mscho527
mscho527 approved these changes Dec 10, 2024
View reviewed changes
Copy link
Member

@mscho527 mscho527 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

                                                      ______
_________________________________________________________  /
_  ___/  __ \  __ \  __ \  __ \  __ \  __ \  __ \  __ \_  / 
/ /__ / /_/ / /_/ / /_/ / /_/ / /_/ / /_/ / /_/ / /_/ /  /  
\___/ \____/\____/\____/\____/\____/\____/\____/\____//_/

@mcocdawc mcocdawc merged commit 27e768c into main Dec 10, 2024
4 checks passed
@mcocdawc mcocdawc deleted the fix_docs branch December 10, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mscho527 mscho527 mscho527 approved these changes

@lweisburn lweisburn Awaiting requested review from lweisburn

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Escalate warnings to errors when building the documentation
2 participants
@mcocdawc @mscho527