aboutsummaryrefslogtreecommitdiff
path: root/doc
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 /doc
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 'doc')
-rw-r--r--doc/Contributing.md5
-rw-r--r--doc/License.md5
-rw-r--r--doc/Manifest.md6
-rw-r--r--doc/Packaging.md5
-rw-r--r--doc/index.md3
-rw-r--r--doc/media/favicon.icobin0 -> 16958 bytes
6 files changed, 24 insertions, 0 deletions
diff --git a/doc/Contributing.md b/doc/Contributing.md
new file mode 100644
index 0000000..5a7fccc
--- /dev/null
+++ b/doc/Contributing.md
@@ -0,0 +1,5 @@
+---
+title: Contributing Guidelines
+---
+
+{!CONTRIBUTING.md!}
diff --git a/doc/License.md b/doc/License.md
new file mode 100644
index 0000000..6a51b7d
--- /dev/null
+++ b/doc/License.md
@@ -0,0 +1,5 @@
+---
+title: License
+---
+
+{!LICENSE!}
diff --git a/doc/Manifest.md b/doc/Manifest.md
new file mode 100644
index 0000000..1ad48ce
--- /dev/null
+++ b/doc/Manifest.md
@@ -0,0 +1,6 @@
+---
+title: Manifest reference
+---
+
+{!manifest-reference.md!}
+
diff --git a/doc/Packaging.md b/doc/Packaging.md
new file mode 100644
index 0000000..46a4c1b
--- /dev/null
+++ b/doc/Packaging.md
@@ -0,0 +1,5 @@
+---
+title: Packaging with fpm
+---
+
+{!PACKAGING.md!}
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..2db3638
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,3 @@
+---
+title: Packaging and contributing
+---
diff --git a/doc/media/favicon.ico b/doc/media/favicon.ico
new file mode 100644
index 0000000..a360390
--- /dev/null
+++ b/doc/media/favicon.ico
Binary files differ