Commit Graph

166 Commits

Author SHA1 Message Date
phaer
bb4b27886f add render_options hook 2024-06-11 19:08:00 +02:00
phaer
42ff2e8d4d move dreamDocs out of docs dir
to reduce unecessary rebuilds
2024-06-11 19:08:00 +02:00
phaer
280bebed2c docs: don't use navigation pruning 2024-06-11 19:07:27 +02:00
phaer
ddf9ba346b docs/modules: fix header hierachy 2024-06-11 19:07:25 +02:00
phaer
c644d0b76a fix link in gettingstarted 2024-06-11 19:07:24 +02:00
phaer
4e3a5000e0 fix logo style in header 2024-06-11 19:07:24 +02:00
phaer
6617d9f90c remove redundant content in docs 2024-06-11 19:07:24 +02:00
phaer
7f355a9506 move notes/module-system-problems to src 2024-06-11 19:07:24 +02:00
phaer
318997a795 remove mdbook site, move content to docs/ 2024-06-11 19:07:22 +02:00
phaer
92d2d31a4c add mkdocs-material...
and more configuration. Also fix favicon path
2024-06-11 19:06:29 +02:00
phaer
7cb146701a add mkdocs-based docs site 2024-06-11 19:05:26 +02:00
DavHau
5798a23484 docs: add reference documentation to website 2023-10-12 00:55:37 +02:00
Ryan Gibb
00b2b09551
typo (#640)
Co-authored-by: DavHau <hsngrmpf+github@gmail.com>
2023-09-05 10:52:31 +02:00
DavHau
165014ec90 examples: add dream2nix-repo-flake 2023-09-03 08:25:17 +00:00
DavHau
f4371d3e9b refactor(examples): re-categorize
new categories:
- basics
- single-language
- multi-language
2023-08-31 12:53:22 +00:00
DavHau
7b96349dd4 notes: add notes/module-system-problems.md 2023-08-06 13:22:48 +00:00
DavHau
352d44bcc9 docs: remove v1 draft API docs from index
... but keep the md files. There are still valuable drafts which are not yet implemented
2023-08-06 10:12:41 +00:00
InLaw
89bab978fc
fix internal links after v1 restructuring (#612)
Co-authored-by: aedsm <service@analytics-endeavor.de>
2023-08-01 16:17:25 +02:00
DavHau
c3f184f09f docs: link examples from the docs 2023-07-29 15:29:06 +02:00
DavHau
d7238d66f3 docs: migrate docs from drv-parts 2023-07-29 13:28:22 +02:00
DavHau
e68bff6dbd docs: improve readme 2023-07-19 16:06:03 +02:00
DavHau
96a11d4197 move v1/nix to top-level 2023-07-19 15:53:03 +02:00
DavHau
7f2965906c docs: remove legacy docs 2023-07-18 19:02:38 +02:00
Jairo Llopis
e2f9f2c211 docs: fix typo on fetchers 2023-07-07 14:11:13 +02:00
Sridhar Ratnakumar
76fba001f3
docs/rust: Fix syntax error in fenix example (#541) 2023-07-01 22:28:40 +03:00
Paul Haerle
16a68020c0
Merge pull request #466 from phaer/patch-1
Update getting-started-python.md
2023-05-30 13:43:35 +02:00
Arnout Engelen
a54969c218
Document how to drop PHP target-dir attribute
Fixes #491 by documenting how to use flake `packageOverrides`
to drop the attribute
2023-03-25 11:16:34 +01:00
DavHau
7f422cf4f3
Merge pull request #490 from raboof/document-adding-projects.toml-to-git
Document adding `project.toml` to git more explicitly
2023-03-17 19:47:28 +07:00
Arnout Engelen
0987c82ee2
Document adding project.toml to git more explicitly
Easy to miss for beginning users :)
2023-03-17 11:25:46 +01:00
Arnout Engelen
88b0e94dfa
Document inspecting the generic lockfile 2023-03-17 09:25:32 +01:00
DavHau
dc9954aae4 feat(v1 API): document v1 API examples 2023-02-06 14:44:19 +07:00
Paul Haerle
cb29b46af6
Update getting-started-python.md
.#default isn't defined in new flakes, see https://github.com/nix-community/dream2nix/issues/464
2023-02-01 15:16:03 +01:00
DavHau
13eb4c8bd1
Merge pull request #455 from waalge/waalge/bump-docs
Waalge/bump docs
2023-01-31 13:50:07 +07:00
DavHau
759c70ed33
Merge pull request #431 from hsjobeki/nodejs/strict-builder-draft
new nodejs strict builder
2023-01-21 16:28:23 +08:00
Ilan Joselevich
f11fa0fced
rust: add rustc to crane's defaultToolchain and to crane devshell (#457)
Co-authored-by: Yusuf Bera Ertan <y.bera003.06@protonmail.com>
2023-01-19 09:33:48 +03:00
waalge
c8ce959207 Add docs: shoe horn 'populate projects.toml' into nix_system section 2023-01-14 11:58:38 +00:00
waalge
f06925610b fix: precommit hook for mdbook failing appropriately 2023-01-14 11:44:37 +00:00
waalge
b48cde9ec9 bad commit? 2023-01-14 11:41:52 +00:00
waalge
e156d5d19f mdbook builds 2023-01-13 17:22:58 +00:00
hsjobeki
749d0f3f5c fix: docs 2023-01-11 11:27:37 +01:00
hsjobeki
1a556e3812 refactor: split concerns in multiple files 2023-01-05 17:37:54 +01:00
hsjobeki
9b701bb6c8 nodejs: clean up builder 2023-01-04 14:31:18 +01:00
hsjobeki
a9001c21eb add: little documentation for new nodejs builder 2022-12-30 22:49:43 +01:00
Yusuf Bera Ertan
a24fb71c40
docs: update docs for rust subsystem 2022-12-18 03:17:28 +03:00
DavHau
986480a327 docs: acknowledge funding more
- Move funding section to the top of the readme
- add funding paragraph to the intro of the docs
2022-12-15 14:04:37 +07:00
DavHau
01b5d43524 chore: use projects.toml in docs and examples 2022-12-13 12:42:03 +07:00
DavHau
cb641555c8 chore: lib.nix remove projectsJson from flake outputs 2022-12-13 12:42:03 +07:00
phaer
c51db6ebeb docs: add pypi-wheel fetcher 2022-11-23 20:43:20 +01:00
DavHau
01f58c8f5b fix: contributing guide 2022-11-21 15:46:54 +01:00
DavHau
919b8f6891 feat: rewrite contributors.md and integration test it 2022-11-16 17:38:00 +01:00
hsjobeki
77a41b1d1f docs: improve override section 2022-11-16 15:10:50 +01:00
Antoine Carnec
d624cf0b6f Set a sensical path in command instructions 2022-11-14 12:55:30 +00:00
Yusuf Bera Ertan
e104aca557
docs: add documentation for setting profile and flags while using crane builder 2022-11-13 15:26:46 +03:00
Yusuf Bera Ertan
03f9323d2c
docs: update extending dream2nix document to reflect module system changes 2022-10-23 02:43:48 +03:00
DavHau
1e0d20959a
docs: add development roundup (july - september) (#326)
Co-authored-by: Yusuf Bera Ertan <y.bera003.06@protonmail.com>
2022-10-17 16:06:21 +00:00
hsjobeki
b05fdf2a40 docs/SUMMARY.md: remove empty draft sections. 2022-10-16 15:40:16 +02:00
hsjobeki
0c8971f1ef docs: improve structure 2022-10-11 11:37:31 +02:00
Martin Toman
26a0088b9d php: add packagist translator 2022-09-27 12:51:19 -07:00
Martin Toman
c07df07605 docs: php: add granular builder 2022-09-17 14:00:25 -07:00
Martin Toman
969cba514c docs: php: add example to docs 2022-09-12 14:54:59 -07:00
Martin Toman
b2269bd1cb docs: php: add builder simple 2022-09-09 12:47:12 -07:00
DavHau
a015a05db4 chore: update documentation for indexers 2022-08-31 20:59:19 +02:00
DavHau
c8e889250b
Merge pull request #271 from tinybeachthor/docs-fetchers
docs: add `Fetchers` section to docs
2022-08-31 12:52:49 +02:00
Martin Toman
f2622d1e09 docs: add outline to python quickstart 2022-08-26 16:29:15 -07:00
Martin Toman
d3524727b2 docs: split out define target platforms subsection 2022-08-26 16:29:12 -07:00
Martin Toman
f41f301e58 docs: fix nodejs quickstart FAQ 2022-08-26 12:03:55 -07:00
Martin Toman
400c2406db docs: fetchers 2022-08-26 12:01:19 -07:00
Martin Toman
ed7edff5ca docs: add php subsystems section 2022-08-25 17:21:08 -07:00
Martin Toman
5893814164 docs: add nodejs to subsystems 2022-08-17 13:25:39 -07:00
DavHau
e654ffaa10 feat: module system improvements
- add documentation to the subsystem-loading interface
- expose evaled modules publicly via `framework`
- add option config.modules to allow users to include their own modules
- update examples for extending dream2nix
2022-08-15 15:34:24 +02:00
DavHau
73d0dbc482
Merge pull request #239 from tinybeachthor/docs-highlight-nix
docs: add nix syntax highlighting
2022-08-11 16:39:45 +02:00
Martin Toman
71e4ba973a docs: add nix syntax highlighting 2022-08-10 10:07:30 -07:00
Martin Toman
206bd6fe82 docs: fix typos 2022-08-09 10:35:28 -07:00
Martin Toman
3e5c108e2c docs: nodejs: add guides/getting-started-nodejs 2022-08-09 10:34:36 -07:00
Martin Toman
92d025e1ae docs: split out "Install nix" section 2022-08-06 10:02:07 -07:00
DavHau
b478f29d7a add documentation for the haskell subsystem 2022-07-22 17:19:54 +02:00
DavHau
e8fe3f803f rename examples under ./examples
Apply naming scheme {subsystem}_{test-name}
2022-07-22 16:02:21 +02:00
DavHau
9ce7b78c1f
Revert "refactor: readme/docs" 2022-07-18 18:58:36 +02:00
DavHau
3808b309dc refactor: readme/docs
The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview.

- add sections `Quick Start` and `Presentation ...` to docs
- move usage examples from readme to `Quick Start` in the docs
- trim down the explanation about `Documentation` a bit
- move the youtube presentation to the end
-
2022-07-17 21:17:41 +02:00
DavHau
932ccb13dc fix systemsFromFile
- make use of config.projectRoot to ge relative path of systems file
2022-07-16 18:58:04 +02:00
DavHau
7cd64d386d python improvements, docs and guide.
- add warning to readme and docs stating that dream2nix is unstable software
- refactor structure of docs: remove title .md pages, instead add titles via (# title) to SUMMARY
- change order of doc topics. move `guides` and `subsystems` to the front
- add docs for python subsystem
- add getting started guide for python
- extend ./examples/python to make use of translator options
- add new function to dlib `systemsFromFile` that allows to load the `supportedSystems` from a file. This alows changing the supported systems without touching the flake.
- move pip translator args to extra file `args.nix` to allow embedding in docs
- fix pip translator
- add a .gitignore to the basic flake template
- use new systemsFromFile function in basic flake template
2022-07-16 15:03:37 +02:00
Lele Gaifax
c69534abef Fix typos in documentation 2022-07-14 11:31:44 +02:00
Yusuf Bera Ertan
d657fcfac8
docs: fix development roundup section 2022-07-12 16:42:12 +03:00
Yusuf Bera Ertan
05167f7e6f
feat: indexers (#184)
* feat: add translate and shell commands

* feat: add indexer modules

* feat(nodejs): add a basic npm indexer

* feat: add an index app for indexing using an indexer

* feat(rust): add crates-io indexer

* refactor: use configFile in more places

* feat: implement translate-index app

* refactor: move indexers out of subsystems since they aren't subsystem specific

* fix: discard string context for config text

* docs: add a preliminary document for indexers

* docs: add examples for crates-io and npm indexer inputs

* feat: add support for setting sourceRoot in dream-lock, fix translate source patching

* fix: don't discard context from config passed as text

* fix: remove duplicate resolves

* fix: shell command

* refactor: remove useless nix calls, improve the apps

* feat: improve cli apps UX, implement runNixCmdInSrc, remove shell

* docs: more comments

* feat: add generatePackagesFromLocksTree util

* fix: pass args to generatePackagesFromDreamLocks correctly

* Update indexers.md

* chore: remove license from crates-io indexer

* fix: pass config loaded from env vars to loadConfig

* refactor: don't expose dream2nix internally

* feat: add makeOutputsForIndexes utility

* refactor: make make(Flake)OutputsForIndexes interface consistent with make(Flake)Outputs

* fix: allow passing pkgs to makeFlakeOutputsForIndexes

* fix: remove unused code

* fix: rename var to expected name

* refactor(utils/index): improve and fix overrideOutputs arg

* fix(utils/index): actually pass prev outputs to overrideOutputs

* refactor: patch all sources instead of using a seperate field in dream lock

* fix(utils/index): use .program to access the program

* fix: correct jq command in translate app

* refactor: improve translate app performance

* feat: add crates-io-simple indexer

* fix(apps/translate): only set dir if relPath is set

* fix(apps/callNixWithD2N): pin nixpkgs

* fix: unloaded config passed to dlib

* refactor: rewrite root source patching in nix

* tests: add a unit test for replace root sources

Co-authored-by: DavHau <hsngrmpf+github@gmail.com>
2022-07-12 12:33:04 +02:00
DavHau
6eb67f2775
Merge pull request #188 from nix-community/dev-roundups
Add development roundup April - June
2022-07-12 11:07:34 +02:00
Yusuf Bera Ertan
757501574f
docs: add more examples for overriding rust-toolchain 2022-07-06 20:30:29 +03:00
Yusuf Bera Ertan
cb09518ff9
docs: mention more stuff in dev roundup 2022-07-06 19:10:51 +03:00
Yusuf Bera Ertan
5e0de19443
docs: move development round ups to separate files 2022-07-06 19:03:04 +03:00
DavHau
4e5e4e4a14 Add development roundup April - June 2022-07-06 16:00:02 +02:00
DavHau
89bfa7c971 docs: rename Concepts and Benefits -> Architectural Considerations 2022-07-06 15:43:21 +02:00
Yusuf Bera Ertan
1ba9555ecf
docs: add the haskell subsystem to subsystems doc 2022-06-21 19:16:05 +03:00
Yusuf Bera Ertan
2dcf2ab21e
docs: fix formatting in rest of the documentation 2022-06-21 19:15:29 +03:00
Yusuf Bera Ertan
5f20f98aa2
feat: implement overrideRustToolchain for crane and build-rust-package (#175) 2022-06-18 18:24:05 +03:00
Yusuf Bera Ertan
7005441ceb
docs: setup mdbook book for documentation, add CLI app for docs (#173)
* docs: setup mdbook book for documentation

* ci: add github action for docs

* docs: add a cli command for showing docs in terminal

* Update docs/src/subsystems/rust.md

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>

* docs(rust): add example for crane overriding

* docs: add a further reading section to intro

* docs: fix a few links

* docs(readme): move documentation section up and fit some sections into 80 columns

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>
2022-06-13 22:27:05 +03:00
Yusuf Bera Ertan
645c6fd98e
refactor: implement a validation system for builders / translators, reorganize files (#155)
* refactor: implement a validation system for builders / translators etc, organize files

* refactor: use seq instead of complicated validation function for validator

* feat: allow adding discoverers, translators and builders via config

* refactor: rework discoverers to use makeSubsystemModules as well

* fix: validate extra modules properly

* feat: support inline modules

* feat: use extra attribute for extending

* feat: make fetchers extensible properly

* fix: add name to extra fetchers

* feat: support list for extra

* docs: add some comment to lib/modules.nix

* fix: get extra module args from extraArgs

* fix: collect all modules instead of only collecting modules for built-in subsystems

* refactor: minor improvements

* refactor: improve how default subsystem modules are declared

* fix: translators and builders are directly under subsystem now

* fix: correct attribute path, remove unused argument

* fix: correct translators attribute paths

* fix: correct file paths and translators attribute paths

* fix: use correct translator attr path in wrapPureTranslator

* fix: update unit tests code

* fix: remove extra paranthesis in unit tests code

* tests: add an extended dream2nix example

* refactor: replace recursiveUpdate usage with normal update op

* tests: fix and extend d2n-extended example

* fix: pass config to d2n instance in wrap pure translator script

* fix: correct toFile usage

* fix: pass config to dlib in more places

* fix: pass config to d2n instance in aggregated hashes cli and gomod2nix translator

* refactor: remove unused extra modules validation, add warning for function modules

* fix: remove non-existent inherited variable

* docs: update translator attr path in contributors guide

* docs: add docs for extending dream2nix

* refactor: comment more code, warn for function modules only if extra is an attrset decl

* docs: fix some typos

* docs: explain some stuff in extending d2n better

* fix: print function modules warning when it is a function

* tests: add a new example that tests adding new subsystem and config.extra as nix file

* tests: use cargo-toml as translator on d2n-extended to potentially catch more bugs

* feat: add ifd warning for builders

* tests: use build-rust-package builder instead of crane builder in d2n-extended to also test it instead of only testing crane builder

* fix(rust/builders): always write the generated Cargo.lock so it doesnt get out of sync with our dream-lock

* fix(rust/builders): delete cargo lock before writing it?

* refactor: also print ifd warnings for translators

* docs: link extending d2n doc in readme, link examples in extending d2n

* docs: example naming (translators.new -> translators.example-translator)

* feat: allow setting nix files for modules declarations (eg. subsystems, subsystems.translators)

* refactor: move IFD warnings to src/lib/builders.nix / translators.nix respectively

* refactor: throw instead of warning if function declarations for modules are used

* refactor: fix throw usage

* refactor: improve modules code

* chore(deps): update nixpkgs

* fix: correct some map usages

* fix: use correct attr path for extra modules

* chore: update examples flake inputs

* style: minor formatting changes
2022-05-29 21:42:47 +02:00
DavHau
fb3789c9a1 update contributors guide 2022-05-19 17:58:08 +02:00
DavHau
25c5d26596 fix URL to overrides in docs 2022-02-18 15:14:01 +07:00
DavHau
49416753cf
Merge pull request #79 from raboof/patch-2
typo: tanslator -> translator
2022-02-04 22:43:55 +07:00
Arnout Engelen
6427775e87
typo: tanslator -> translator 2022-02-04 16:38:14 +01:00
Arnout Engelen
dad2395b01
typo compsition -> composition 2022-02-04 16:29:21 +01:00