tools/nix: move nix flakes to tools/
This commit moves the flake.lock and flake.nix files from root and Documentation/ to the tools/ directory, according to @anchao's suggestion in PR #16763. Updates documentation to reflect this change. Signed-off-by: Côme VINCENT <44554692+comejv@users.noreply.github.com>
This commit is contained in:
parent
585c25bac0
commit
c36d067603
5 changed files with 9 additions and 6 deletions
|
|
@ -22,7 +22,7 @@ the NuttX directory and run:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
nix develop
|
nix develop ./tools/nix
|
||||||
|
|
||||||
This command will:
|
This command will:
|
||||||
|
|
||||||
|
|
@ -50,7 +50,7 @@ To enter the documentation shell, run:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
nix develop .#docs
|
nix develop ./tools/nix#docs
|
||||||
|
|
||||||
This command will:
|
This command will:
|
||||||
|
|
||||||
|
|
@ -74,7 +74,7 @@ Example usage:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Build HTML docs
|
# Build HTML docs (has to but run in Documentation/ directory)
|
||||||
make html
|
make html
|
||||||
|
|
||||||
See the :doc:`/contributing/documentation` guide for more details.
|
See the :doc:`/contributing/documentation` guide for more details.
|
||||||
|
|
|
||||||
|
|
@ -72,6 +72,9 @@
|
||||||
{
|
{
|
||||||
devShells.${system}.default = pkgs.mkShell {
|
devShells.${system}.default = pkgs.mkShell {
|
||||||
buildInputs = [ nuttx-doc-py-env ];
|
buildInputs = [ nuttx-doc-py-env ];
|
||||||
|
shellHook = ''
|
||||||
|
echo "Welcome to NuttX documentation devShell"
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
4
flake.lock → tools/nix/flake.lock
generated
4
flake.lock → tools/nix/flake.lock
generated
|
|
@ -5,11 +5,11 @@
|
||||||
"nixpkgs": "nixpkgs"
|
"nixpkgs": "nixpkgs"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"path": "./Documentation",
|
"path": "./doc/",
|
||||||
"type": "path"
|
"type": "path"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"path": "./Documentation",
|
"path": "./doc/",
|
||||||
"type": "path"
|
"type": "path"
|
||||||
},
|
},
|
||||||
"parent": []
|
"parent": []
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
inputs = {
|
inputs = {
|
||||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||||
flake-utils.url = "github:numtide/flake-utils";
|
flake-utils.url = "github:numtide/flake-utils";
|
||||||
documentation.url = "path:./Documentation";
|
documentation.url = "path:./doc/";
|
||||||
};
|
};
|
||||||
|
|
||||||
outputs =
|
outputs =
|
||||||
Loading…
Add table
Reference in a new issue