Skip to content

Commit 59092ed

Browse files
committed
Add FORD instructions to the README
1 parent de0ede6 commit 59092ed

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Read the paper [here](https://arxiv.org/abs/1902.06714).
1515
- [Training the network](https://github.com/modern-fortran/neural-fortran#training-the-network)
1616
- [Saving and loading from file](https://github.com/modern-fortran/neural-fortran#saving-and-loading-from-file)
1717
- [MNIST training example](https://github.com/modern-fortran/neural-fortran#mnist-training-example)
18+
* [API documentation](https://github.com/modern-fortran/neural-fortran#api-documentation)
1819
* [Contributing](https://github.com/modern-fortran/neural-fortran#contributing)
1920
* [Contributors](https://github.com/modern-fortran/neural-fortran#contributors)
2021
* [Related projects](https://github.com/modern-fortran/neural-fortran#related-projects)
@@ -369,6 +370,18 @@ for example on 16 cores using [OpenCoarrays](https://github.com/sourceryinstitut
369370
$ cafrun -n 16 ./example_mnist
370371
```
371372

373+
## API documentation
374+
375+
API documentation can be generated with [FORD](https://github.com/Fortran-FOSS-Programmers/ford/).
376+
Assuming you have FORD installed on your system, run
377+
378+
```
379+
ford ford.md
380+
```
381+
382+
from the neural-fortran top-level directory to generate the API documentation in doc/html.
383+
Point your browser to doc/html/index.html to read it.
384+
372385
## Contributing
373386

374387
neural-fortran is currently a proof-of-concept with potential for

0 commit comments

Comments
 (0)