Skip to content

Commit 6a108ff

Browse files
committed
initial cut at switching from robodoc to ford.
1 parent 997e4f9 commit 6a108ff

File tree

5 files changed

+1113
-3083
lines changed

5 files changed

+1113
-3083
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
bin/
22
lib/
33
builds/
4+
doc/
45
*.mod
56
*.o
67
*.obj

build.sh

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@
6363

6464
set -e
6565

66-
PROJECTNAME='jsonfortran' # project name for robodoc (example: jsonfortran_2.0.0)
66+
#PROJECTNAME='jsonfortran' # project name for robodoc (example: jsonfortran_2.0.0)
67+
FORDMD='json-fortran.md' # FORD options file for building documentation
6768
DOCDIR='./documentation/' # build directory for documentation
6869
SRCDIR='./src/' # library source directory
6970
TESTDIR='./src/tests/' # unit test source directory
@@ -284,14 +285,16 @@ else
284285
echo "Skip building the unit tests since \$JF_SKIP_TESTS has been set to 'true'."
285286
fi
286287

287-
#build the documentation with RoboDoc (if present):
288+
#build the documentation with ford (if present):
288289
echo ""
289290
if [[ $JF_SKIP_DOCS != [yY]* ]]; then
290-
if hash robodoc 2>/dev/null; then
291+
if hash ford 2>/dev/null; then
291292
echo "Building documentation..."
292-
robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --documenttitle ${PROJECTNAME}
293+
#robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --documenttitle ${PROJECTNAME}
294+
ford $FORDMD
293295
else
294-
echo "ROBODoc not found! Cannot build documentation. ROBODoc can be installed from: http://www.xs4all.nl/~rfsber/Robo/"
296+
#echo "ROBODoc not found! Cannot build documentation. ROBODoc can be installed from: http://www.xs4all.nl/~rfsber/Robo/"
297+
echo "ford not found! Install using: sudo pip install ford"
295298
fi
296299
else
297300
echo "Skip building documentation since \$JF_SKIP_DOCS has been set to ${JF_SKIP_DOCS}."

json-fortran.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
project: json-fortran
2+
project_dir: ./src
3+
output_dir: ./doc
4+
project_github: https://github.com/jacobwilliams/json-fortran
5+
summary: JSON-FORTRAN -- A Fortran 2008 JSON API
6+
author: Jacob Williams
7+
github: https://github.com/jacobwilliams
8+
predocmark_alt: >
9+
docmark_alt: <
10+
exclude_dir: tests
11+
exclude_dir: introspection
12+
display: public
13+
display: protected
14+
display: private
15+
source: true
16+
17+
# Brief description
18+
19+
A user-friendly and object-oriented API for reading and writing JSON files, written in
20+
modern Fortran (Fortran 2003+). The source code is a single Fortran module file ([json_module.F90](https://github.com/jacobwilliams/json-fortran/blob/master/src/json_module.F90)).
21+
22+
# License
23+
24+
The json-fortran source code and related files and documentation are distributed under a permissive free software license (BSD-style). See the [LICENSE](https://raw.githubusercontent.com/jacobwilliams/json-fortran/master/LICENSE) file for more details.
25+
26+
# Miscellaneous
27+
28+
* For more information about JSON, see: <http://www.json.org/>

0 commit comments

Comments
 (0)