aboutsummaryrefslogtreecommitdiff
path: root/docs.md
diff options
context:
space:
mode:
authorSebastian Ehlert <28669218+awvwgk@users.noreply.github.com>2020-11-10 21:34:04 +0100
committerGitHub <noreply@github.com>2020-11-10 21:34:04 +0100
commite034ad418ad8da3754b80a9673b7017e9798b2a0 (patch)
treedd367c479e5b1e7c5e9b43b5b9f2366528709460 /docs.md
parentd569a89d7d059a5ba914e51d6fd7b32132b33c5e (diff)
downloadfpm-e034ad418ad8da3754b80a9673b7017e9798b2a0.tar.gz
fpm-e034ad418ad8da3754b80a9673b7017e9798b2a0.zip
Add automatic documentation for Fortran fpm (#209)
- create docs.md as input for FORD - fix docstrings and comment style for FORD - workaround FORD bug by adding whitespace to table headers - add manifest reference to FORD pages - apply ugly workaround to not replace array of tables with links
Diffstat (limited to 'docs.md')
-rw-r--r--docs.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs.md b/docs.md
new file mode 100644
index 0000000..800cfab
--- /dev/null
+++ b/docs.md
@@ -0,0 +1,32 @@
+---
+project: Fortran-lang/fpm
+summary: Fortran Package Manager
+project_github: https://github.com/fortran-lang/fpm
+project_download: https://github.com/fortran-lang/fpm/archive/master.zip
+author: fortran-lang/fpm 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
+src_dir: ./fpm/src
+output_dir: ./fpm-doc
+page_dir: ./doc
+media_dir: ./doc/media
+exclude_dir: ./bootstrap
+ ./archive
+ ./test
+display: public
+ protected
+source: true
+proc_internals: true
+sort: permission-alpha
+favicon: doc/media/favicon.ico
+print_creation_date: true
+extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
+creation_date: %Y-%m-%d %H:%M %z
+md_extensions: markdown.extensions.toc
+ markdown.extensions.smarty
+---
+
+[TOC]