diff --git a/.circleci/config.yml b/.circleci/config.yml index b7eb4c30eadc7282e1e2f69f488b5800b765b993..3256c18de0ec272c5182b93fb0d8b423cdaa2fc2 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 f1552d5cec4e08d636ec9cf0ef83ea667ddfbb11..675c9a7fbf9f17f63f025ca843d8e985735b366b 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 0000000000000000000000000000000000000000..068656ccfbf7aabee907d6ffb3ac28c37415f7b7 --- /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 d06ae0d59b4ca91cbd00cd4a440da275f26f609e..e712e0e44c7d5e4b83f94c8798b2d089cf12edda 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