Commit Graph

166 Commits

Author SHA1 Message Date
phaer
1b50cccec4 docs/pip: fix typo 2024-07-29 18:26:02 +02:00
phaer
601b7dfd2b editables: fix path ordering, remove relics...
...of the former feature which linked sources in .dream2nix/editables.
This was sadly uncleanly removed before
2024-07-29 18:26:02 +02:00
phaer
23e728be98 docs/pip: document devShells 2024-07-29 13:22:22 +02:00
phaer
1b8d980b74 treewide: mytool -> my_tool
Keep naming consitant, so that nix run .# and friends work
2024-07-29 13:22:22 +02:00
phaer
c58f0449ae docs: fix typo 2024-07-29 13:22:22 +02:00
phaer
9c9cb9f892 docs: apply fixes from review
thanks @purepani
2024-07-29 13:22:22 +02:00
phaer
31cb800529 doc/getting-started: drop deps explaination...
as deps is introduced in pip, where it's actually needed
2024-07-29 13:22:22 +02:00
phaer
95f59a4f60 docs/guides: add local python example to pip guide 2024-07-29 13:22:22 +02:00
phaer
65e02ebfe2 docs/guides: fix pip headers 2024-07-29 13:22:22 +02:00
phaer
65eca90173 docs/guide: mention pips cross-platform limits 2024-07-29 13:22:22 +02:00
phaer
adeed1750a docs/guide: first draft of pip guide 2024-07-29 13:22:22 +02:00
phaer
a0c1e83a03 docs: be more explicit about the annotations
in getting-started
2024-07-29 13:22:22 +02:00
DavHau
b14eca8b2c Revert "website: revert back to nix-community.github.io/dream2nix"
This reverts commit fcbfd63231.
2024-07-29 10:37:19 +00:00
DavHau
736f7ac951 website: revert back to nix-community.github.io/dream2nix 2024-07-29 06:49:00 +00:00
DavHau
4e9fd61a12 reference-docs: fix option rendering issue
remove tree-style preprocessing since it is not needed anymore
2024-07-18 15:30:23 +00:00
DavHau
4c89b02025 website: change to https://dream2nix.dev 2024-07-18 13:07:26 +00:00
DavHau
0859b0dfdf docs: improve table of contents for options
- increase width of toc
- show full option path in toc
- no nesting

This simplifies navigation on option pages a lot.
2024-07-11 15:56:58 +00:00
DavHau
a3751775d9 docs: fix broken links 2024-07-11 14:47:28 +00:00
DavHau
d639e70caf reference website: categorize into released/experimental/internal 2024-07-11 14:41:18 +00:00
DavHau
37fca4bf27 reference website: render all options with same heading size 2024-07-11 14:41:18 +00:00
phaer
363a6996c3 docs: mv gettingstarted to guides/getting-started 2024-07-09 20:16:09 +02:00
phaer
7b48877133 docs: reworked gettingstarted.md 2024-07-09 20:16:09 +02:00
phaer
69d78dbcad docs: fix incorrect option rendering...
for first children of nested options.

thanks @yorickvP for reporting this in
https://github.com/nix-community/dream2nix/pull/987
2024-07-04 10:17:01 +02:00
phaer
68e0c76cb5 docs: enable copy button for code blocks 2024-06-26 19:05:13 +02:00
phaer
9aae1937a4 docs: Experimental -> Experimental Modules 2024-06-18 15:39:32 +02:00
phaer
233a797b5c docs: put modules where state != "released"...
into a separate navigation section.
2024-06-18 15:32:24 +02:00
phaer
c1d1502486 docs: improve options reference layout 2024-06-18 13:17:48 +02:00
phaer
5f3051487a docs: don't render full paths in reference toc 2024-06-18 13:01:19 +02:00
phaer
eeb48666ca docs: fix reference titles 2024-06-18 12:58:02 +02:00
phaer
b6b9e5d2fb docs: customize toc-item.html
to add collapsible subtrees
2024-06-18 12:55:38 +02:00
phaer
b4ceedaafd docs: fix sorting, don't hardcode pip ;) 2024-06-18 10:46:22 +02:00
phaer
855cfa5e77 docs: fix display of collapsible sidebar items 2024-06-18 09:11:18 +02:00
phaer
4175449e93 docs: syntax highlighting in reference 2024-06-18 09:10:48 +02:00
phaer
e62c7b759a docs: custom sort for rendered options 2024-06-17 14:30:23 +02:00
phaer
df887721f7 reference options: escape < and > 2024-06-16 14:39:21 +02:00
phaer
7aca3e34ff docs: fix rendering of examples 2024-06-16 13:35:07 +02:00
phaer
8cf6639c8b docs: fix missing options of submodules 2024-06-15 20:34:53 +02:00
phaer
f2f428f758 docs: add extra header to reference docs 2024-06-15 11:53:27 +02:00
phaer
d4c77a62d6 docs: children -> option 2024-06-14 15:48:38 +02:00
phaer
4266fcc0ab docs: fix typo 2024-06-14 15:31:43 +02:00
phaer
b80a263443 add docs/README.md 2024-06-14 14:28:30 +02:00
phaer
32023d41ed docs: enable permalink links for headings 2024-06-14 13:39:41 +02:00
phaer
8aa4a44eaf docs: link github repo 2024-06-14 12:23:10 +02:00
phaer
9dba824ae8 docs: add reference header 2024-06-13 15:47:07 +02:00
phaer
b6bae07d51 docs move options reference template to own file 2024-06-13 14:44:44 +02:00
phaer
66d8e84cee docs: remove anchors warning
...because it's not yet supported in our mkdocs version
2024-06-13 13:38:03 +02:00
phaer
5c6e0e5e9a docs: add mkdocs-awesome-pages-plugin 2024-06-13 13:06:22 +02:00
phaer
c1e70d4528 remove unecessary font declaration 2024-06-11 22:30:38 +02:00
phaer
44f9f95b36 don't integrate toc 2024-06-11 22:30:12 +02:00
phaer
e01ce3d09b add favicon 2024-06-11 22:29:50 +02:00