extension problem

[gigster99]

from the FAQ: https://docs.readthedocs.org/en/latest/faq.html
"The NumPy and Google styles are two popular docstring formats. Fortunately, the default Read The Docs theme handles both formats just fine, provided your conf.py specifies an appropriate Sphinx extension that knows how to convert your customized docstrings."

However, when using napoleon, receive this error message:
https://readthedocs.org/builds/nutrients/1914206/
ImportError: No module named 'sphinx.ext.napoleon'

Settings in my 'conf.py' look like this:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
]

Am also trying to run the extension:
'sphinxcontrib.bibtex',

In my 'requirements.txt' file have setting:
sphinxcontrib-bibtex

Settings in my 'conf.py' look like this:
extensions = [
'sphinxcontrib.bibtext',
]

However, when executing, receive this error message:
ImportError: No module named 'sphinxcontrib'
https://readthedocs.org/builds/nutrients/1914067/

What am I doing wrong with these two methods (napoleon and bibtex)?

[gigster99]

OK, I corrected my error WRT 'sphinxcontrib.' Error was failing to correctly set the virt env and identify the requirements.txt doc in Advanced settings. Will work on the 'napoleon' issue next. I think the problem there is that sphinx.ext.napoleon is for Sphinx 1.3 only. I'll fall back to the sphinxcontrib.napoleon and see if that works.

[guyfawcus]

See #995 for related talk.

I think you just need to add sphinxcontrib-napoleon to your requirements.txt then use sphinxcontrib.napoleon in your conf.py.

[gigster99]

TY - will do.

/g

From: James F-Robinson [mailto:[email protected]]
Sent: Tuesday, December 02, 2014 8:23 AM
To: rtfd/readthedocs.org
Cc: gig graham
Subject: Re: [readthedocs.org] extension problem (#1059)

See #995 #995 for related talk.

I think you just need to add sphinxcontrib-napoleon to your requirements.txt then use the sphinxcontrib.napoleon in your conf.py.

—
Reply to this email directly or view it on GitHub #1059 (comment) . https://github.com/notifications/beacon/AB9THrmn2xdiZyig5XOQVd8PzD7iOaBHks5nTcLPgaJpZM4DC758.gif

[gigster99]

James F-Robinson advice worked. TY. IMHO it's not easy to learn how to manage extensions for RTD. May make sense to add an explicit addendum to the RTD documentation illustrating how to do so.
/g

[ericholscher]

Yea, I think it's something we're blind to as Python developers -- it would
be awesome if you did a first draft of a doc for us, so that we can make
sure we don't make too many assumptions. It is definitely something we
should document better.

On Tue, Dec 2, 2014 at 12:58 PM, gig graham [email protected]
wrote:

James F-Robinson advice worked. TY. IMHO it's not easy to learn how to
manage extensions for RTD. May make sense to add an explicit addendum to
the RTD documentation illustrating how to do so.
/g

—
Reply to this email directly or view it on GitHub
#1059 (comment)
.

Eric Holscher
Maker of the internet residing in Portland, Or
http://ericholscher.com

[michaelaye]

Isn't it wrong to add sphinx stuff to the requirements.txt that really only should contain dependencies for the actual Python module to work?

[ofloveandhate]

@michaelaye i got this sense, too. it feels weird to require my users to install packages needed for documentation only.