Skip to content

Commit b96a53e

Browse files
committed
Transitioned documentation style to FORD. Fixes #2
1 parent 57f05cc commit b96a53e

File tree

5 files changed

+81
-555
lines changed

5 files changed

+81
-555
lines changed

build.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ FoBiS.py build -compiler ${FCOMPILER} -cflags "${FCOMPILERFLAGS}" -dbld ${BINDIR
2424

2525
# build the documentation:
2626

27-
if hash robodoc 2>/dev/null; then
27+
if hash ford 2>/dev/null; then
2828
echo "Building documentation..."
29-
robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --documenttitle ${PROJECTNAME}
29+
ford pyplot-fortran.md
3030
else
31-
echo "ROBODoc not found! Cannot build documentation. ROBODoc can be obtained from: http://www.xs4all.nl/~rfsber/Robo/"
31+
echo "FORD not found! Cannot build documentation. To install, run: sudo pip install ford"
3232
fi

pyplot-fortran.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
project: pyplot-fortran
2+
project_dir: src
3+
output_dir: doc
4+
project_github: https://github.com/jacobwilliams/pyplot-fortran
5+
summary: For generating plots from Fortran using Python's matplotlib.pyplot
6+
author: Jacob Williams
7+
github: https://github.com/jacobwilliams
8+
predocmark_alt: >
9+
predocmark: <
10+
docmark_alt:
11+
docmark: !
12+
display: public
13+
protected
14+
private
15+
source: true
16+
17+
# Brief description
18+
19+
Currently, this module can be used to generate simple plots from Fortran. Eventually, it may be expanded to provide additional features and other types of plots.
20+
21+
The way it works is simply to generate a Python script with the plotting code, which
22+
is then executed from the command line using the Fortran ```execute_command_line``` function.

0 commit comments

Comments
 (0)