Skip to content

Tweak To Sphinx Install Documentation - #3271

Merged
paulromano merged 1 commit into
openmc-dev:developfrom
jtramm:sphinx_doc_string
Jan 21, 2025
Merged

paulromano merged 1 commit into
openmc-dev:developfrom
jtramm:sphinx_doc_string

Conversation

@jtramm

@jtramm jtramm commented Jan 21, 2025

Copy link
Copy Markdown
Contributor

Description

The current command in the docs for how to install the Sphinx python dependencies works on linux, but requires the addition of some quotes to work on MacOS. This PR adds those quotes so those wanting to build the docs on Mac don't get stuck. The quotes should work fine on linux as well.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@jtramm
jtramm requested a review from paulromano January 21, 2025 15:46

@paulromano paulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

@paulromano
paulromano merged commit 560bd22 into openmc-dev:develop Jan 21, 2025
@jtramm
jtramm deleted the sphinx_doc_string branch January 21, 2025 22:38
ebknudsen pushed a commit to ebknudsen/openmc that referenced this pull request Jan 27, 2025
apingegno pushed a commit to apingegno/openmc that referenced this pull request May 7, 2026
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.

2 participants