From 94a8a537cc1a1c3fde3792f811d7e5be892b2bae Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 7 Aug 2019 14:42:16 -0400
Subject: [PATCH] Some doc improvements
---
.circleci/config.yml | 2 +-
README.rst | 4 +++-
docs/source/README.rst | 2 ++
docs/source/index.rst | 3 +++
nixos/{tests.nix => unit-tests.nix} | 0
5 files changed, 9 insertions(+), 2 deletions(-)
create mode 100644 docs/source/README.rst
rename nixos/{tests.nix => unit-tests.nix} (100%)
diff --git a/.circleci/config.yml b/.circleci/config.yml
index b7eb4c30..3256c18d 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -30,7 +30,7 @@ jobs:
- run:
name: "Run Tests"
command: |
- nix-build nixos/tests.nix && cat result
+ nix-build nixos/unit-tests.nix && cat result
build:
docker:
diff --git a/README.rst b/README.rst
index f1552d5c..675c9a7f 100644
--- a/README.rst
+++ b/README.rst
@@ -13,7 +13,7 @@ Documentation
The documentation can be built using this command::
- nix-build docs.nix
+ $ nix-build docs.nix
The documentation is also built on and published by CI.
@@ -33,3 +33,5 @@ The system tests are run using this command::
$ nix-build nixos/system-tests.nix
The system tests boot QEMU VMs which prevents them from running on CI at this time.
+
+.. _Nix: https://nixos.org/nix
diff --git a/docs/source/README.rst b/docs/source/README.rst
new file mode 100644
index 00000000..068656cc
--- /dev/null
+++ b/docs/source/README.rst
@@ -0,0 +1,2 @@
+.. include::
+ ../../README.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
index d06ae0d5..e712e0e4 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -10,8 +10,11 @@ Welcome to PrivateStorageio's documentation!
:maxdepth: 2
:caption: Contents:
+ README
architecture-overview
+
+
Indices and tables
==================
diff --git a/nixos/tests.nix b/nixos/unit-tests.nix
similarity index 100%
rename from nixos/tests.nix
rename to nixos/unit-tests.nix
--
GitLab