1
0
forked from clan/clan-core

docs: clean up directory structure

This commit is contained in:
Johannes Kirschbauer 2024-04-13 14:42:37 +02:00
parent 7d543da8c2
commit babf7e3d12
Signed by: hsjobeki
SSH Key Fingerprint: SHA256:vX3utDqig7Ph5L0JPv87ZTPb/w7cMzREKVZzzLFg9qU
23 changed files with 10 additions and 12 deletions

1
.gitignore vendored
View File

@ -11,6 +11,7 @@ result*
/pkgs/clan-cli/clan_cli/webui/assets /pkgs/clan-cli/clan_cli/webui/assets
nixos.qcow2 nixos.qcow2
**/*.glade~ **/*.glade~
/docs/out
# python # python
__pycache__ __pycache__

View File

@ -1,6 +1,6 @@
source_up source_up
watch_file flake-module.nix shell.nix default.nix watch_file nix/flake-module.nix nix/shell.nix nix/default.nix
# Because we depend on nixpkgs sources, uploading to builders takes a long time # Because we depend on nixpkgs sources, uploading to builders takes a long time
use flake .#docs --builders '' use flake .#docs --builders ''

2
docs/.gitignore vendored
View File

@ -1,2 +0,0 @@
# build oputputs
site

View File

@ -9,8 +9,6 @@ validation:
absolute_links: warn absolute_links: warn
unrecognized_links: warn unrecognized_links: warn
markdown_extensions:
markdown_extensions: markdown_extensions:
- pymdownx.tasklist: - pymdownx.tasklist:
custom_checkbox: true custom_checkbox: true
@ -41,7 +39,10 @@ nav:
- Backup & Restore: getting-started/backups.md - Backup & Restore: getting-started/backups.md
- Flake-parts: getting-started/flake-parts.md - Flake-parts: getting-started/flake-parts.md
- Templates: templates/index.md - Templates: templates/index.md
- Contributing: contributing.md - Contributing: contributing/contributing.md
docs_dir: site
site_dir: out
theme: theme:
logo: static/logo.png logo: static/logo.png
@ -72,8 +73,5 @@ theme:
icon: material/weather-sunny icon: material/weather-sunny
name: Switch to light mode name: Switch to light mode
extra_css:
- stylesheets/extra.css
plugins: plugins:
- search - search

View File

@ -2,7 +2,7 @@
pkgs.stdenv.mkDerivation { pkgs.stdenv.mkDerivation {
name = "clan-documentation"; name = "clan-documentation";
src = ./.; src = ../.;
nativeBuildInputs = nativeBuildInputs =
[ pkgs.python3 ] [ pkgs.python3 ]

View File

@ -0,0 +1 @@
../../contributing.md

View File

@ -109,7 +109,7 @@ clan machines install my-machine <target_host>
> Note: This may take a while for building and for the file transfer. > Note: This may take a while for building and for the file transfer.
#### 🎉 🚀 Your machine is all set up 🎉 🚀 Your machine is all set up
--- ---

View File

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

View File

@ -40,7 +40,7 @@
./devShell.nix ./devShell.nix
# TODO: migrate this @davHau # TODO: migrate this @davHau
# ./docs/flake-module # ./docs/flake-module
./docs/flake-module.nix ./docs/nix/flake-module.nix
./formatter.nix ./formatter.nix
./lib/flake-module.nix ./lib/flake-module.nix
./nixosModules/flake-module.nix ./nixosModules/flake-module.nix