Open ostueker opened 5 years ago
Hi @ostueker
which version do you use ?
Hi @stefraynaud, I am using the master branch at e61d9a2 (July 12th, 2018; i.e. the latest) with Python 2.7.
I've workaround it by putting documentation on extra, cleaner definitions, for example:
!.. |c_esc| replace:: actual c_esc description...
! ...
character(len=1), parameter :: c_end = 'm', c_esc = achar(27)
character(len=2), parameter :: c_start = c_esc // '['
! ...
private :: c_end ! |c_end|
private :: c_esc ! |c_esc|
private :: c_start ! |c_start|
! ...
Thank you Stephane, that commit seems to fix the issue.
However I noticed that sphinx-fortran now needs sphinx >= 1.8 as with 1.7.5 (in my previous env) I got the following error:
reading sources... [ 28%] RefactoringFortranForSphinx
Exception occurred:
File "build/bdist.linux-x86_64/egg/sphinxfortran/fortran_domain.py", line 595, in handle_signature
'module', self.env.temp_data.get('f:module'))
AttributeError: 'DirectiveAdapter' object has no attribute 'env'
The full traceback has been saved in /tmp/sphinx-err-6cxcqG.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2
But with Sphinx v1.8.2 it works.
Oliver, can you check that it works for you now?
Thank you, @stefraynaud !
It now works with both sphinx 1.7.5 and 1.8.2 (I haven't tried any other versions).
I'm currently working on some instructional material on using Sphinx for Fortran projects and I noticed that the autodoc feature mixes up the descriptions of parameters.
E.g. when I have the following Fortran code:
you can see here that the description of
nd
is just gone and the one ofrij
shows up next toj
. Code is at https://github.com/ostueker/Example_Fortran (filesrc/sub_calc_distance.f90
).Any idea if maybe I am doing something wrong?