Permalink
Browse files

fixing broken docs (#134)

* fixing broken docs

* travis will now raise errors if docs break

* added sphinx to requirements for doc testing

* make sphinx nit-picky

* added sphinx_rtd_theme to travis
  • Loading branch information...
babbush committed Dec 18, 2017
1 parent 9b2289b commit f04197ef7874b17934bcd46a4a31709bf60169fa
Showing with 9 additions and 6 deletions.
  1. +3 −0 .travis.yml
  2. +3 −3 src/openfermion/hamiltonians/_molecular_data.py
  3. +3 −3 src/openfermion/ops/_polynomial_tensor.py
View
@@ -44,7 +44,10 @@ install:
- pip$PY install pytest
- pip$PY install pytest-cov
- pip$PY install coveralls
- pip$PY install sphinx
- pip$PY install sphinx_rtd_theme
script: sphinx-build -nW -b html -d docs/_build/doctrees/ docs/ docs/_build/html
script: export OMP_NUM_THREADS=1 && pytest src/openfermion --cov src/openfermion
after_success:
@@ -714,7 +714,7 @@ def get_from_file(self, property_name):
"""Helper routine to re-open HDF5 file and pull out single property
Args:
property_name(string): Property name to load from self.filename
property_name: Property name to load from self.filename
Returns:
The data located at file[property_name] for the HDF5 file at
@@ -768,9 +768,9 @@ def get_active_space_integrals(self,
n an orthonormal basis set.
Args:
occupied_indices(list): A list of spatial orbital indices
occupied_indices: A list of spatial orbital indices
indicating which orbitals should be considered doubly occupied.
active_indices(list): A list of spatial orbital indices indicating
active_indices: A list of spatial orbital indices indicating
which orbitals should be considered active.
Returns:
@@ -46,9 +46,9 @@ def general_basis_change(general_tensor, rotation_matrix, key):
n_qubits by n_qubits. Assumed to be unitary.
key: A tuple indicating the type of general_tensor. Assumed to be
non-empty. For example, a tensor storing coefficients of
a^\dagger_p a_q would have a key of (1, 0) whereas a tensor
storing coefficients of a^\dagger_p a_q a_r a^\dagger_s would
have a key of (1, 0, 0, 1).
:math:`a^\dagger_p a_q` would have a key of (1, 0) whereas a tensor
storing coefficients of :math:`a^\dagger_p a_q a_r a^\dagger_s`
would have a key of (1, 0, 0, 1).
Returns:
transformed_general_tensor: general_tensor in the rotated basis.

0 comments on commit f04197e

Please sign in to comment.