From 1d4e9300770ab9455afd66228d60a1b2e0598e70 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 17:36:06 -0400 Subject: [PATCH 01/11] Add automatic API-doc generation & deployment --- .github/workflows/doc-deployment.yml | 60 ++++++++++++++++++++++++++++ .gitignore | 4 ++ API-doc-FORD-file.md | 51 +++++++++++++++++++++++ doc/API.md | 6 ++- doc/index.md | 3 ++ 5 files changed, 123 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/doc-deployment.yml create mode 100644 API-doc-FORD-file.md create mode 100644 doc/index.md diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml new file mode 100644 index 000000000..82031bff5 --- /dev/null +++ b/.github/workflows/doc-deployment.yml @@ -0,0 +1,60 @@ +name: Build and Deploy Documents + +on: [push, pull_request] + +env: + LANG: "en_US.UTF-8" + LC_ALL: "en_US.UTF-8" + HOMEBREW_DISPLAY_INSTALL_TIMES: "ON" + HOMEBREW_NO_ANALYTICS: "ON" + HOMEBREW_NO_AUTO_UPDATE: "ON" + HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK: "ON" + HOMEBREW_NO_GITHUB_API: "ON" + HOMEBREW_NO_INSTALL_CLEANUP: "ON" + PIP_DISABLE_PIP_VERSION_CHECK: "ON" + PIP_NO_CLEAN: "ON" + PIP_PREFER_BINARY: "ON" + TZ: "UTC" + +jobs: + Build-API-Docs: + runs-on: macos-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # Full history to get tag and commit info + - name: Install Dependencies + run: | + pip3 install --prefer-binary --no-clean --disable-pip-version-check --progress-bar off lxml fypp + brew install -f --force-bottle --keep-tmp ford + type -a ford + ford --version + gfortran --version + - name: Build Docs + run: | + git fetch --all --tags + ford -r $(git describe --always) --debug API-doc-FORD-file.md + zip -vr API-docs.zip API-doc/ -x "*.DS_Store" + - name: Upload Documentation + uses: actions/upload-artifact@v2 + with: + name: FORD-API-docs + path: ./API-docs.zip + - name: Broken Link Check + uses: technote-space/broken-link-checker-action@v1 + with: + TARGET: file://${{ github.workspace }}/API-doc/index.html + RECURSIVE: true + ASSIGNEES: ${{ github.actor }} + - name: Deploy API Docs + uses: peaceiris/gh-pages@v3 +# if: github.event_name == 'push' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) + with: + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} + external_repository: fortran-lang/stdlib-docs + publish_dir: ./API-doc + publish_branch: master + allow_empty_commit: true + force_orphan: false + user_name: ${{ github.actor }} + commit_message: "From https://github.com/${{ github.repository }}/commit/${{ github.sha }} ${{ github.ref }}" diff --git a/.gitignore b/.gitignore index 8a63b480c..d6e779c07 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,9 @@ build/ +# FORD generated documentation +# !WARNING! This folder gets deleted and overwritten +API-doc/ + # Prerequisites *.d diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md new file mode 100644 index 000000000..e0bebdd2d --- /dev/null +++ b/API-doc-FORD-file.md @@ -0,0 +1,51 @@ +--- +project: Fortran-lang/stdlib +summary: A community driven standard library for (modern) Fortran +src_dir: src +exclude_dir: src/tests +output_dir: API-doc +page_dir: doc +fpp_extensions: fypp +preprocess: true +macro: MAXRANK=4 +preprocessor: fypp +display: public + protected + private +source: true +proc_internals: true +md_extensions: markdown.extensions.toc +graph: true +graph_maxnodes: 200 +coloured_edges: true +sort: permission-alpha +extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html + iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING +print_creation_date: true +creation_date: %Y-%m-%d %H:%M %z +project_github: https://github.com/fortran-lang/stdlib +project_download: https://github.com/fortran-lang/stdlib/archive/master.zip +project_website: https://stdlib.fortran-lang.org +license: by-sa +author: fortran-lang/stdlib contributors +author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png +author_email: fortran-lang@groups.io +github: https://github.com/fortran-lang +twitter: https://twitter.com/fortranlang +website: https://fortran-lang.org +dbg: true +--- + +[TOC] + +@warning This API documentation for the Fortran-lang/stdlib is a work in progress + +Fortran stdlib API Documentation +================================ + +This the main API documentation landing page generated by [FORD]. +The documentation for comment markup in source code, running [FORD] and the [FORD project file] are all maintained on the [FORD wiki]. + +[FORD]: https://github.com/Fortran-FOSS-Programmers/ford#readme +[FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki +[FORD project file]: https://github.com/fortran-lang/stdlib/blob/master/API-doc-FORD-file.md diff --git a/doc/API.md b/doc/API.md index b8e138eb7..6a8e8c33f 100644 --- a/doc/API.md +++ b/doc/API.md @@ -1,3 +1,7 @@ +--- +title: Fortran stdlib API +--- + # Fortran stdlib API -TODO +@todo expand or remove diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 000000000..cb6397d38 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,3 @@ +--- +title: Specs, examples & user documentation +--- From 09bc27616937ff2aa89be6b1768f853e6984d632 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 17:47:20 -0400 Subject: [PATCH 02/11] Fix bad action name --- .github/workflows/doc-deployment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml index 82031bff5..0e098234c 100644 --- a/.github/workflows/doc-deployment.yml +++ b/.github/workflows/doc-deployment.yml @@ -47,7 +47,7 @@ jobs: RECURSIVE: true ASSIGNEES: ${{ github.actor }} - name: Deploy API Docs - uses: peaceiris/gh-pages@v3 + uses: peaceiris/actions-gh-pages@v3 # if: github.event_name == 'push' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} From ded1f63e0820b598fce3ec3babfc50a9fa97189f Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 17:48:16 -0400 Subject: [PATCH 03/11] Move specs into FORD pages specs dir --- {src => doc/specs}/stdlib_experimental_error.md | 0 {src => doc/specs}/stdlib_experimental_io.md | 0 {src => doc/specs}/stdlib_experimental_linalg.md | 0 {src => doc/specs}/stdlib_experimental_optval.md | 0 {src => doc/specs}/stdlib_experimental_quadrature.md | 0 {src => doc/specs}/stdlib_experimental_stats.md | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename {src => doc/specs}/stdlib_experimental_error.md (100%) rename {src => doc/specs}/stdlib_experimental_io.md (100%) rename {src => doc/specs}/stdlib_experimental_linalg.md (100%) rename {src => doc/specs}/stdlib_experimental_optval.md (100%) rename {src => doc/specs}/stdlib_experimental_quadrature.md (100%) rename {src => doc/specs}/stdlib_experimental_stats.md (100%) diff --git a/src/stdlib_experimental_error.md b/doc/specs/stdlib_experimental_error.md similarity index 100% rename from src/stdlib_experimental_error.md rename to doc/specs/stdlib_experimental_error.md diff --git a/src/stdlib_experimental_io.md b/doc/specs/stdlib_experimental_io.md similarity index 100% rename from src/stdlib_experimental_io.md rename to doc/specs/stdlib_experimental_io.md diff --git a/src/stdlib_experimental_linalg.md b/doc/specs/stdlib_experimental_linalg.md similarity index 100% rename from src/stdlib_experimental_linalg.md rename to doc/specs/stdlib_experimental_linalg.md diff --git a/src/stdlib_experimental_optval.md b/doc/specs/stdlib_experimental_optval.md similarity index 100% rename from src/stdlib_experimental_optval.md rename to doc/specs/stdlib_experimental_optval.md diff --git a/src/stdlib_experimental_quadrature.md b/doc/specs/stdlib_experimental_quadrature.md similarity index 100% rename from src/stdlib_experimental_quadrature.md rename to doc/specs/stdlib_experimental_quadrature.md diff --git a/src/stdlib_experimental_stats.md b/doc/specs/stdlib_experimental_stats.md similarity index 100% rename from src/stdlib_experimental_stats.md rename to doc/specs/stdlib_experimental_stats.md From 6c9c2bb550606ab77cedf0c19ac129a5eab6baa6 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 18:05:22 -0400 Subject: [PATCH 04/11] Update specs w/ title meta data and automated TOC --- doc/specs/index.md | 5 +++++ doc/specs/stdlib_experimental_error.md | 8 +++++--- doc/specs/stdlib_experimental_io.md | 8 +++++--- doc/specs/stdlib_experimental_linalg.md | 8 +++++--- doc/specs/stdlib_experimental_optval.md | 6 +++++- doc/specs/stdlib_experimental_quadrature.md | 9 +++++---- doc/specs/stdlib_experimental_stats.md | 10 +++++----- 7 files changed, 35 insertions(+), 19 deletions(-) create mode 100644 doc/specs/index.md diff --git a/doc/specs/index.md b/doc/specs/index.md new file mode 100644 index 000000000..87ed1ad8a --- /dev/null +++ b/doc/specs/index.md @@ -0,0 +1,5 @@ +--- +title: specs +--- + +@todo Explain what these are, how to write them, why they're needed, etc. diff --git a/doc/specs/stdlib_experimental_error.md b/doc/specs/stdlib_experimental_error.md index d6c8ca9ae..67ab84bed 100644 --- a/doc/specs/stdlib_experimental_error.md +++ b/doc/specs/stdlib_experimental_error.md @@ -1,8 +1,10 @@ -# Catching and handling errors +--- +title: experimental_error +--- -* [`check` - Checks the value of a logical condition](#check---checks-the-value-of-a-logical-condition) -* [`error_stop` - aborts the program](#error_stop---aborts-the-program) +# Catching and handling errors +[TOC] ## `check` - Checks the value of a logical condition diff --git a/doc/specs/stdlib_experimental_io.md b/doc/specs/stdlib_experimental_io.md index 7057a31c7..b600241fa 100644 --- a/doc/specs/stdlib_experimental_io.md +++ b/doc/specs/stdlib_experimental_io.md @@ -1,8 +1,10 @@ +--- +title: experimental_IO +--- + # IO -* [`loadtxt` - load a 2D array from a text file](#loadtxt---load-a-2d-array-from-a-text-file) -* [`open` - open a file](#open---open-a-file) -* [`savetxt` - save a 2D array into a text file](#savetxt---save-a-2d-array-into-a-text-file) +[TOC] ## `loadtxt` - load a 2D array from a text file diff --git a/doc/specs/stdlib_experimental_linalg.md b/doc/specs/stdlib_experimental_linalg.md index c59e5020d..de5ff8684 100644 --- a/doc/specs/stdlib_experimental_linalg.md +++ b/doc/specs/stdlib_experimental_linalg.md @@ -1,8 +1,10 @@ +--- +title: experimental_linalg +--- + # Linear Algebra -* [`diag` - Create a diagonal array or extract the diagonal elements of an array](#diag---create-a-diagonal-array-or-extract-the-diagonal-elements-of-an-array) -* [`eye` - Construct the identity matrix](#eye---construct-the-identity-matrix) -* [`trace` - Trace of a matrix](#trace---trace-of-a-matrix) +[TOC] ## `diag` - Create a diagonal array or extract the diagonal elements of an array diff --git a/doc/specs/stdlib_experimental_optval.md b/doc/specs/stdlib_experimental_optval.md index 4e74ddc6c..4a86ff932 100644 --- a/doc/specs/stdlib_experimental_optval.md +++ b/doc/specs/stdlib_experimental_optval.md @@ -1,6 +1,10 @@ +--- +title: experimental_optval +--- + # Default values for optional arguments -* [`optval` - fallback value for optional arguments](#optval---fallback-value-for-optional-arguments) +[TOC] ## `optval` - fallback value for optional arguments diff --git a/doc/specs/stdlib_experimental_quadrature.md b/doc/specs/stdlib_experimental_quadrature.md index 8e6a4d8d9..5a1d2b01a 100644 --- a/doc/specs/stdlib_experimental_quadrature.md +++ b/doc/specs/stdlib_experimental_quadrature.md @@ -1,9 +1,10 @@ +--- +title: experimental_quadrature +--- + # Numerical integration -* [`trapz` - integrate sampled values using trapezoidal rule](#trapz---integrate-sampled-values-using-trapezoidal-rule) -* [`trapz_weights` - trapezoidal rule weights for given abscissas](#trapz_weights---trapezoidal-rule-weights-for-given-abscissas) -* [`simps` - integrate sampled values using Simpson's rule (to be implemented)](#simps---integrate-sampled-values-using-simpsons-rule-to-be-implemented) -* [`simps_weights` - Simpson's rule weights for given abscissas (to be implemented)](#simps_weights---simpsons-rule-weights-for-given-abscissas-to-be-implemented) +[TOC] ## `trapz` - integrate sampled values using trapezoidal rule diff --git a/doc/specs/stdlib_experimental_stats.md b/doc/specs/stdlib_experimental_stats.md index 8fe1d763f..62d5cf551 100644 --- a/doc/specs/stdlib_experimental_stats.md +++ b/doc/specs/stdlib_experimental_stats.md @@ -1,10 +1,10 @@ -# Descriptive statistics +--- +title: experimental_stats +--- -* [`cov` - covariance of array elements](#cov---covariance-of-array-elements) -* [`mean` - mean of array elements](#mean---mean-of-array-elements) -* [`moment` - central moments of array elements](#moment---central-moments-of-array-elements) -* [`var` - variance of array elements](#var---variance-of-array-elements) +# Descriptive statistics +[TOC] ## `cov` - covariance of array elements From 5e9c5e7240061e463520305b1af7936107826562 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 18:37:02 -0400 Subject: [PATCH 05/11] Add note about navbar to FORD API doc landing page - Also, see if redeployment will work now --- API-doc-FORD-file.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index e0bebdd2d..a69aa2e7e 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -17,6 +17,7 @@ proc_internals: true md_extensions: markdown.extensions.toc graph: true graph_maxnodes: 200 +graph_maxdepth: 5 coloured_edges: true sort: permission-alpha extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html @@ -40,6 +41,10 @@ dbg: true @warning This API documentation for the Fortran-lang/stdlib is a work in progress +@info +Use the navigation bar at the top of the screen to browse modules, procedures, source files, etc. +The listings near the bottom of the page are incomplete. + Fortran stdlib API Documentation ================================ From b22b6e665bdabcfa5e62e3c2337252693b13f314 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 18:47:55 -0400 Subject: [PATCH 06/11] Add favicon --- API-doc-FORD-file.md | 2 ++ doc/media/favicon.ico | Bin 0 -> 16958 bytes 2 files changed, 2 insertions(+) create mode 100644 doc/media/favicon.ico diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index a69aa2e7e..5204b4368 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -5,6 +5,7 @@ src_dir: src exclude_dir: src/tests output_dir: API-doc page_dir: doc +media_dir: doc/media fpp_extensions: fypp preprocess: true macro: MAXRANK=4 @@ -27,6 +28,7 @@ creation_date: %Y-%m-%d %H:%M %z project_github: https://github.com/fortran-lang/stdlib project_download: https://github.com/fortran-lang/stdlib/archive/master.zip project_website: https://stdlib.fortran-lang.org +favicon: doc/media/favicon.ico license: by-sa author: fortran-lang/stdlib contributors author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png diff --git a/doc/media/favicon.ico b/doc/media/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..a3603903a25b295d0a3e5019494454005dfbe159 GIT binary patch literal 16958 zcmeI3?Nb{?7{IU75B=yjKU!aB`e$_fY?DaUQ7ctD&ghIEl)I$$4Tw&yj#C{Sn}k$_ zA~>}5r7a>YP$^@fU`wG$c?mC;m)2nru@o92g*@()<7n^P+ug))bJ=t=o6YXt?d|V* z_VzW8qHG|aty>lHeZR8hQAN2|QIsvjlO!cbJf>&jqQ1aG5uc`od|G4JrwxU@>dmlM z19$sW9b>6FdsH>Nz39Po*`wR`+!yv}QNp?6ZdM^(B*Q-cQPib~9Ks&;Il{as0k^fC z#v>kW2TKNoxkN&4lN=&GwU{OY@}3vU&VHNE|LmPI2ziPgCV4Wpd6VvM^K0?XxA`A1 zWI)mn-;rl`k5uU)uU3uxtGZ9x@&6b+2u`{7$~q@yoWwC9E4?3gYwKae(1L>QY~ z!+*$8{gbw)HW2m^7JqGN)T!nVZRNF2wtsw9j5nt}{&v_g{?;##JI%kq(mm!??s^Y; zYJY*ghISY}+YRHL{V+8+1~+GKWF(j5$_o5_Z5pPBCt&i@5d7ZW3xmxUptrsaj=uh} z)BKq~&*z86{Z)WGqHZcS4i$x^nLpEoYp-jUM@8}B)Q5+pV#oJm^jwcHe@?Y;!L}AV z(<#hf^Xf;^>3`to^TPb!yz)U_^H;sJS3dsJ;`*8;{}s;%x%@cKn46k0 z`HAir_deb{X1((J)8PMVM=_U!HlEH-OmXj9FFszm{f!;M`v2nTx40ZPrf2_Co-F(a zpL&DIUskZ2I-it4~`zoOO*cq6g zxlRXPP37_9zEaos&462vmRMk`ObAmse{SOvD${^GAPw!8yQt;zknC5u; z$1_Blb434X?EmrfUtU;3!{Dxe@LZARa*ZF~0a_ox)IV8MCKlo}{M3I}vfbZV%foR- z)baF>W#iep)v@@iU*2cEd@b&T{s+=H{}AEtt!stEeB9(wCRVu{@uvONYrNJUxyWyD ziH5B6S4a5MIR6yUzbH3ehvx}Par-?4C-_&cXk(o!^)Wr$of~*)}~`My@&m{sm&^Gs+rsq~<3!T@kN#I$!y98!>+%U-^lx zms<8%;1R;_3j2p__cNULKV|=bHXvvp$7%zT=G7oOy45z2kd%|Qc3iaDg%UfMo%zBa z@u<6W&6~eNK7TL|WKd$JHpj@A@C=bbTtYb{LO%5cGc7%Kpg`M9_`fFJc3j9I`K0Wh zv5%wE+NY-aMUOwQI!7Aj*$TNsCaL-SFxDAu`_R78o={PedS+=t4>w=e!+XZ`a8rvO jZVc+-1|!s?cfZ{t0YfiF*rHc# Date: Thu, 14 May 2020 18:51:56 -0400 Subject: [PATCH 07/11] `@info` -> `@note` & shorten pages titlebar name --- API-doc-FORD-file.md | 2 +- doc/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index 5204b4368..3548b6366 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -43,7 +43,7 @@ dbg: true @warning This API documentation for the Fortran-lang/stdlib is a work in progress -@info +@note Use the navigation bar at the top of the screen to browse modules, procedures, source files, etc. The listings near the bottom of the page are incomplete. diff --git a/doc/index.md b/doc/index.md index cb6397d38..52f960f3d 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,3 +1,3 @@ --- -title: Specs, examples & user documentation +title: Specs, examples & user docs --- From 0348e36ec4c3c488b2dcbd906cb16192d0f7e33f Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 19:49:28 -0400 Subject: [PATCH 08/11] Try resolving error by removing username --- .github/workflows/doc-deployment.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml index 0e098234c..5250011cf 100644 --- a/.github/workflows/doc-deployment.yml +++ b/.github/workflows/doc-deployment.yml @@ -56,5 +56,4 @@ jobs: publish_branch: master allow_empty_commit: true force_orphan: false - user_name: ${{ github.actor }} commit_message: "From https://github.com/${{ github.repository }}/commit/${{ github.sha }} ${{ github.ref }}" From ffe5f50e4a920cdb2b77187ef9f7dfd7b8d20517 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 20:15:15 -0400 Subject: [PATCH 09/11] Add-back branch/tag deploy guard --- .github/workflows/doc-deployment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml index 5250011cf..331433a04 100644 --- a/.github/workflows/doc-deployment.yml +++ b/.github/workflows/doc-deployment.yml @@ -48,7 +48,7 @@ jobs: ASSIGNEES: ${{ github.actor }} - name: Deploy API Docs uses: peaceiris/actions-gh-pages@v3 -# if: github.event_name == 'push' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) + if: github.event_name == 'push' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} external_repository: fortran-lang/stdlib-docs From 7fc3e21bb54b89a5078eb9d239fc236951e96da9 Mon Sep 17 00:00:00 2001 From: Izaak Beekman Date: Thu, 14 May 2020 20:17:09 -0400 Subject: [PATCH 10/11] Ensure that forks don't push to docs repo --- .github/workflows/doc-deployment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml index 331433a04..fb43c25ee 100644 --- a/.github/workflows/doc-deployment.yml +++ b/.github/workflows/doc-deployment.yml @@ -48,7 +48,7 @@ jobs: ASSIGNEES: ${{ github.actor }} - name: Deploy API Docs uses: peaceiris/actions-gh-pages@v3 - if: github.event_name == 'push' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) + if: github.event_name == 'push' && github.repository == 'fortran-lang/stdlib' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} external_repository: fortran-lang/stdlib-docs From bc26bf1aad313ea32e658d6129d3f741e0ea9e18 Mon Sep 17 00:00:00 2001 From: "Izaak \"Zaak\" Beekman" Date: Fri, 15 May 2020 11:40:18 -0400 Subject: [PATCH 11/11] Fix typo found by @jvdp1 A was missing Co-authored-by: Jeremie Vandenplas --- API-doc-FORD-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index 3548b6366..dcd054c84 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -50,7 +50,7 @@ The listings near the bottom of the page are incomplete. Fortran stdlib API Documentation ================================ -This the main API documentation landing page generated by [FORD]. +This is the main API documentation landing page generated by [FORD]. The documentation for comment markup in source code, running [FORD] and the [FORD project file] are all maintained on the [FORD wiki]. [FORD]: https://github.com/Fortran-FOSS-Programmers/ford#readme