diff --git a/Documentation/guides/nix_flake.rst b/Documentation/guides/nix_flake.rst index 3fb8a63e5c..1b728f1341 100644 --- a/Documentation/guides/nix_flake.rst +++ b/Documentation/guides/nix_flake.rst @@ -22,7 +22,7 @@ the NuttX directory and run: .. code-block:: bash - nix develop + nix develop ./tools/nix This command will: @@ -50,7 +50,7 @@ To enter the documentation shell, run: .. code-block:: bash - nix develop .#docs + nix develop ./tools/nix#docs This command will: @@ -74,7 +74,7 @@ Example usage: .. code-block:: bash - # Build HTML docs + # Build HTML docs (has to but run in Documentation/ directory) make html See the :doc:`/contributing/documentation` guide for more details. diff --git a/Documentation/flake.lock b/tools/nix/doc/flake.lock similarity index 100% rename from Documentation/flake.lock rename to tools/nix/doc/flake.lock diff --git a/Documentation/flake.nix b/tools/nix/doc/flake.nix similarity index 94% rename from Documentation/flake.nix rename to tools/nix/doc/flake.nix index 659174d7d0..a33e5bc9ec 100644 --- a/Documentation/flake.nix +++ b/tools/nix/doc/flake.nix @@ -72,6 +72,9 @@ { devShells.${system}.default = pkgs.mkShell { buildInputs = [ nuttx-doc-py-env ]; + shellHook = '' + echo "Welcome to NuttX documentation devShell" + ''; }; }; } diff --git a/flake.lock b/tools/nix/flake.lock similarity index 96% rename from flake.lock rename to tools/nix/flake.lock index 26ab4e5ba8..65ac1342e8 100644 --- a/flake.lock +++ b/tools/nix/flake.lock @@ -5,11 +5,11 @@ "nixpkgs": "nixpkgs" }, "locked": { - "path": "./Documentation", + "path": "./doc/", "type": "path" }, "original": { - "path": "./Documentation", + "path": "./doc/", "type": "path" }, "parent": [] diff --git a/flake.nix b/tools/nix/flake.nix similarity index 96% rename from flake.nix rename to tools/nix/flake.nix index 8dd08be477..38f4c54282 100644 --- a/flake.nix +++ b/tools/nix/flake.nix @@ -4,7 +4,7 @@ inputs = { nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; flake-utils.url = "github:numtide/flake-utils"; - documentation.url = "path:./Documentation"; + documentation.url = "path:./doc/"; }; outputs =