Skip to content

Use nbsphinx for rendering Jupyter notebooks in documentation#1690

Merged
pshriwise merged 2 commits intoopenmc-dev:developfrom
paulromano:nbsphinx
Oct 20, 2020
Merged

Use nbsphinx for rendering Jupyter notebooks in documentation#1690
pshriwise merged 2 commits intoopenmc-dev:developfrom
paulromano:nbsphinx

Conversation

@paulromano
Copy link
Copy Markdown
Contributor

Building documentation is currently broken due to an issue with the nbconvert package that is used under the hood when converting Jupyter notebooks. This is addressed by using the nbsphinx which is much better than our existing notebook_sphinxext.py that is bundled in our repository.

Copy link
Copy Markdown
Contributor

@pshriwise pshriwise left a comment

Choose a reason for hiding this comment

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

With those symbolic links to the notebooks added, this worked well for me! The notebooks look much better and it's nice to be rid of those additional .rst files. Thanks @paulromano!

Will merge today if there are no further comments.

@pshriwise pshriwise merged commit cf324e2 into openmc-dev:develop Oct 20, 2020
@paulromano paulromano deleted the nbsphinx branch October 21, 2020 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants