Skip to content

Commit a362b18

Browse files
committed
CI and readme updates
1 parent be8ad2e commit a362b18

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

.github/workflows/CI.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
if: contains( matrix.os, 'ubuntu')
4040
run: |
4141
python -m pip install --upgrade pip
42-
pip install ford numpy matplotlib
42+
pip install numpy matplotlib ford
4343
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
4444
4545
- name: Install GFortran Linux
@@ -76,7 +76,7 @@ jobs:
7676
files: build/coverage/coverage.info
7777

7878
- name: Build documentation
79-
run: ford ./pyplot-fortran.md
79+
run: ford ./ford.md
8080

8181
- name: Deploy Documentation
8282
if: github.ref == 'refs/heads/master'

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
A simple module for generating plots from Fortran using Python's matplotlib.pyplot.
55

6-
### Status
6+
### Status
77

88
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/pyplot-fortran.svg?style=plastic)](https://github.com/jacobwilliams/pyplot-fortran/releases/latest)
99
![Build Status](https://github.com/jacobwilliams/pyplot-fortran/actions/workflows/CI.yml/badge.svg)
@@ -18,9 +18,9 @@ is then executed from the command line using the Fortran ```execute_command_line
1818

1919
### Compiling
2020

21-
The module requires a modern Fortran compiler (it uses various Fortran 2003/2008 features such as deferred-length strings). It should work fine with the latest gfortran or ifort compilers.
21+
The module requires a modern Fortran compiler (it uses various Fortran 2003/2008 features such as deferred-length strings). It should work fine with the latest gfortran or ifort compilers.
2222

23-
A `fmp.toml` file is provided for compiling pyplot-fortran with the [Fortran Package Manager](https://github.com/fortran-lang/fpm). For example, to build:
23+
A `fpm.toml` file is provided for compiling pyplot-fortran with the [Fortran Package Manager](https://github.com/fortran-lang/fpm). For example, to build:
2424

2525
```
2626
fpm build --profile release
@@ -58,7 +58,7 @@ or, to use a specific version:
5858
pyplot-fortran = { git="https://github.com/jacobwilliams/pyplot-fortran.git", tag = "3.3.0" }
5959
```
6060

61-
To generate the documentation using [ford](https://github.com/Fortran-FOSS-Programmers/ford), run: ```ford pyplot-fortran.md```
61+
To generate the documentation using [ford](https://github.com/Fortran-FOSS-Programmers/ford), run: ```ford ford.md```
6262

6363
### Supported plot types
6464

@@ -103,7 +103,7 @@ The following example generates a plot of the sine function:
103103

104104
### Documentation
105105

106-
* The API documentation for the current ```master``` branch can be found [here](https://jacobwilliams.github.io/pyplot-fortran/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
106+
* The API documentation for the current ```master``` branch can be found [here](https://jacobwilliams.github.io/pyplot-fortran/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
107107

108108
### See also
109109

File renamed without changes.

0 commit comments

Comments
 (0)