Skip to content

Commit

Permalink
Enable Jupyter notebook execution, add link to docs in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
ppinski-hqs committed Apr 30, 2024
1 parent c2b82c8 commit da924f1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ directory.

## Documentation

Please [click here](https://hqsquantumsimulations.github.io/ActiveSpaceFinder) for the
Active Space Finder documentation.

Sphinx documentation of the package is contained in the `doc` folder. It can be built
after checking out the repository with the following steps. The documentation integrates Jupyter
notebooks that require [Jmol](https://jmol.sourceforge.net/) to create orbital plots. Building the
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
dependencies are not importable at build time."""

# nbsphinx
nbsphinx_execute = "never"
nbsphinx_execute = "always"
"""Explicitly dis-/enabling notebook execution. Possible options: 'always', 'auto', 'never'."""

# -- Options for HTML output -------------------------------------------------
Expand Down

0 comments on commit da924f1

Please sign in to comment.