Skip to content

Commit 2a9ce5c

Browse files
committed
added robodoc.rc file for Fortran syntax highlighting in the api documentation.
1 parent 91a15ad commit 2a9ce5c

File tree

4 files changed

+130
-3
lines changed

4 files changed

+130
-3
lines changed

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ set ( ROBODOC_SKIP_DOC_GEN FALSE CACHE BOOL
124124
if ( NOT ROBODOC_SKIP_DOC_GEN )
125125
find_program ( ROBODOC robodoc )
126126
if ( ROBODOC ) # Found
127-
set ( ROBODOC_OPTIONS --tabsize 4 --index --toc --sections --syntaxcolors --source_line_numbers
127+
set ( ROBODOC_OPTIONS --rc robodoc.rc --tabsize 4 --index --toc --sections --syntaxcolors --source_line_numbers
128128
CACHE STRING "Options passed to robodoc to control building the documentation" )
129129
set ( DOC_DIR "${CMAKE_BINARY_DIR}/documentation" )
130130
set ( REQUIRED_ROBODOC_OPTIONS

SConstruct

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ if find_executable('robodoc'):
6464
join('documentation','robodoc.css'),
6565
join('documentation','toc_index.html'), ]
6666

67-
bld = Builder(action='robodoc --src src/ --doc documentation/ --multidoc --html'+
67+
bld = Builder(action='robodoc --rc robodoc.rc --src src/ --doc documentation/ --multidoc --html'+
6868
' --ignore_case_when_linking --syntaxcolors --source_line_numbers --index --tabsize 4 --documenttitle jsonfortran --sections')
6969
env = Environment(BUILDERS = {'RoboDoc' : bld})
7070
env.RoboDoc(docfiles, src)

build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ echo "Building example program..."
5454
#build the documentation with RoboDoc:
5555
echo ""
5656
echo "Building documentation..."
57-
robodoc --src ${SRCDIR} --doc ${DOCDIR} --multidoc --html --ignore_case_when_linking --syntaxcolors --source_line_numbers --index --tabsize 4 --documenttitle ${PROJECTNAME} --sections
57+
robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --multidoc --html --ignore_case_when_linking --syntaxcolors --source_line_numbers --index --tabsize 4 --documenttitle ${PROJECTNAME} --sections
5858
echo ""

robodoc.rc

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
#
2+
# DESCRIPTION
3+
# Example robodoc.rc file for Fortran
4+
#
5+
# NOTES
6+
# Fortran keywords (77-2008) from http://fortranwiki.org/fortran/show/Keywords
7+
# Also added a few missing ones at the bottom.
8+
#
9+
# AUTHOR
10+
# Jacob Williams, 12/28/2014
11+
#
12+
13+
source line comments:
14+
!
15+
keywords:
16+
assign
17+
backspace
18+
block data
19+
call
20+
close
21+
common
22+
continue
23+
data
24+
dimension
25+
do
26+
else
27+
else if
28+
end
29+
endfile
30+
endif
31+
entry
32+
equivalence
33+
external
34+
format
35+
function
36+
goto
37+
if
38+
implicit
39+
inquire
40+
intrinsic
41+
open
42+
parameter
43+
pause
44+
print
45+
program
46+
read
47+
return
48+
rewind
49+
rewrite
50+
save
51+
stop
52+
subroutine
53+
then
54+
write
55+
allocatable
56+
allocate
57+
case
58+
contains
59+
cycle
60+
deallocate
61+
elsewhere
62+
exit
63+
include
64+
interface
65+
intent
66+
module
67+
namelist
68+
nullify
69+
only
70+
operator
71+
optional
72+
pointer
73+
private
74+
procedure
75+
public
76+
recursive
77+
result
78+
select
79+
sequence
80+
target
81+
use
82+
while
83+
where
84+
elemental
85+
forall
86+
pure
87+
abstract
88+
associate
89+
asynchronous
90+
bind
91+
class
92+
deferred
93+
enum
94+
enumerator
95+
extends
96+
final
97+
flush
98+
generic
99+
import
100+
non_overridable
101+
nopass
102+
pass
103+
protected
104+
value
105+
volatile
106+
wait
107+
block
108+
codimension
109+
do concurrent
110+
contiguous
111+
critical
112+
error stop
113+
submodule
114+
sync all
115+
sync images
116+
sync memory
117+
lock
118+
unlock
119+
associated
120+
allocated
121+
present
122+
character
123+
type
124+
integer
125+
real
126+
logical
127+
none

0 commit comments

Comments
 (0)