search

VACUMM / sphinx-fortran

Fortran domain and autodoc extensions to Sphinx
Other
45 stars 29 forks source link

I have solved an error "KeyError: 'vardescsearch'". #25

Open kousuke-nakano opened 4 years ago

kousuke-nakano commented 4 years ago

Dear developers,

I encountered a error when I was making a document:

File "~/.pyenv/versions/anaconda3-2019.10/lib/python3.7/site-packages/sphinxfortran/fortran_autodoc.py", line 348, in scan m = block'vardescsearch' KeyError: 'vardescsearch'

I have solved the error by changing the following lines in fortran_autodoc.py:

line 348 if line.strip().startswith('!'): continue m = block'vardescsearch' if m: block['vars'][m.group('varname').lower()]['desc'] = m.group('vardesc')

to if line.strip().startswith('!'): continue if 'vardescsearch' in block: m = block'vardescsearch' if m: block['vars'][m.group('varname').lower()]['desc'] = m.group('vardesc')

Also, in the user manual, I wonder

.. f:autovariable:: modname

instead,

.. f:automodule:: modname

Best regards.

stefraynaud commented 4 years ago

Thanks for your report. Please, can your make a pull request?