aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2014-12-30 03:45:46 +0100
committerbnewbold <bnewbold@robocracy.org>2014-12-30 03:45:46 +0100
commitd8f92042e8c4e575d322211f8e295e9a77c62719 (patch)
treed0d30e53914453c509b579502e121f78e04b7741
parent2a16ea2a9075229b2141c62697f4e1cabd4d2edd (diff)
downloadfpga-lube-d8f92042e8c4e575d322211f8e295e9a77c62719.zip
fpga-lube-d8f92042e8c4e575d322211f8e295e9a77c62719.tar.gz
docs README pulled in on front page
-rw-r--r--docs/README.txt4
-rw-r--r--docs/index.rst1
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/README.txt b/docs/README.txt
new file mode 100644
index 0000000..de34731
--- /dev/null
+++ b/docs/README.txt
@@ -0,0 +1,4 @@
+
+This is sphinx documentation. Build with ``make html``.
+
+The web version is hosted on readthedocs using git hooks for autogeneration.
diff --git a/docs/index.rst b/docs/index.rst
index 557e8c1..35412a1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,3 +13,4 @@ Contents:
About This Document
---------------------
+.. include:: README.txt