| name | sphinx-common-issues |
| description | Sub-skill of sphinx: Common Issues (+1). |
| version | 1.0.0 |
| category | development |
| type | reference |
| scripts_exempt | true |
Common Issues (+1)
Common Issues
Autodoc Cannot Find Module
import sys
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parents[2] / 'src'))
Intersphinx Inventory Not Loading
intersphinx_mapping = {
'python': ('https://docs.python.org/3', 'python-objects.inv'),
}
Build Warnings as Errors
sphinx-build -b html docs/source docs/build/html
sphinx-build -b html docs/source docs/build/html -W
Napoleon Not Parsing Docstrings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
def func():
"""
Summary line.
Args:
param: Description. # Note: proper indentation
"""
PDF Build Fails
sudo apt-get install texlive-full
brew install --cask mactex
pdflatex --version
latexmk --version
Debug Mode
sphinx-build -b html docs/source docs/build/html -v
sphinx-build -b html docs/source docs/build/html -vvv
sphinx-build -b html docs/source docs/build/html -T
sphinx-build -b html docs/source docs/build/html --keep-going