search

UDST / choicemodels

Python library for discrete choice modeling
https://udst.github.io/choicemodels
BSD 3-Clause "New" or "Revised" License
74 stars 33 forks source link

Fixing a ReadTheDocs build problem #59

Closed smmaurer closed 5 years ago

smmaurer commented 5 years ago

ReadTheDocs.org had an error building the prior PR, and rather than fiddling with customized build environments I'd like to get everything working using the defaults.

Error

python /home/docs/checkouts/readthedocs.org/user_builds/choicemodels/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html
Running Sphinx v1.7.9
loading translations [en]... done

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/choicemodels/envs/latest/local/lib/python2.7/site-packages/sphinx/cmdline.py", line 303, in main
    args.warningiserror, args.tags, args.verbosity, args.jobs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/choicemodels/envs/latest/local/lib/python2.7/site-packages/sphinx/application.py", line 191, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/choicemodels/envs/latest/local/lib/python2.7/site-packages/sphinx/application.py", line 411, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/choicemodels/envs/latest/local/lib/python2.7/site-packages/sphinx/registry.py", line 318, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname, err)
ExtensionError: Could not import extension numpydoc (exception: No module named numpydoc)

Extension error:
Could not import extension numpydoc (exception: No module named numpydoc)

Likely solution

Seems like Napoleon is the preferred Sphinx extension for parsing docstrings now, rather than Numpydoc (which I had copied from somewhere).

Info: https://pypi.org/project/sphinxcontrib-napoleon/

Versioning

unchanged

coveralls commented 5 years ago

Coverage Status

Coverage remained the same at 75.151% when pulling 02f2ed755d410eb12c6b0a9f0aadcae60594c95c on readthedocs-fixes into a87b332a25170670bbfdd0a7d563f15bce4e1f28 on master.