Commit Graph

10 Commits

Author SHA1 Message Date
Alejandro Sanchez Medina
a63b9c15c9 doc: Update manuals bespoke syntax
doc: add figure definition to bespoke syntax reference

doc: add example definition to bespoke syntax reference

doc: add footnote definition to beskpoke syntax reference

The usage of footnotes in the manuals is not the one documented
in markdown-it-py: https://python-markdown.github.io/extensions/footnotes/

doc: add inline comment definition to beskpoke syntax reference

doc: add typographic replacements to beskpoke syntax reference

doc: Fix rendering of bespoke syntax reference

doc: remove references to DocBook in the NixOS manual

doc: add entry on lack of HTML support

doc: Minor improvement

doc: update typographic replacements entry in beskpoke syntax reference

doc: add link reference definitions to beskpoke syntax reference

doc: fix footnote definition in beskpoke syntax reference

doc: Minor improvements from code review

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-01-25 16:33:35 +01:00
Doron Behar
62730f2c31
Merge pull request #248701 from doronbehar/nixos/manpages
nixos/install-tools: Add manpages to packages instead of seperating them
2023-08-16 15:49:49 +00:00
Doron Behar
307da96e17
nixos/doc: small rephrase in documentation of documentation
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-08-16 06:24:37 +00:00
Doron Behar
924a07dc22 nixos/doc: Improve documentation of documentation
- Move contents of README.md from
  nixos/modules/installer/tools/manpages/ to
  nixos/doc/manual/contributing-to-this-manual.chapter.md.
- Don't mention DocBook as its obsolete and too specific.
- Rename derivation attribute name of configuration.nix(5) manual page,
  both on the `contributing-to-this-manual.chapter.md`, and in other
  places.
2023-08-12 22:28:04 +03:00
Silvan Mosberger
37ba768fb4
Merge pull request #241871 from mobusoperandi/doc-doc-syntax-chapter
doc syntax section into chapter, link from nixos manual
2023-08-10 16:11:25 +02:00
Shahar "Dawn" Or
a064709342 nixpkgs/NixOS manuals: devmode feature
Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-07-25 17:03:15 +07:00
Alejandro Sanchez Medina
ad224d61d0 nixos manual contributing link to nixpkgs syntax
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-07-10 15:56:42 +07:00
pennae
d041641b1a nixos/manual: remove md-to-db
with manual chapters no longer needing pandoc for their conversion to
xml we can get rid of this source of confusion, and its huge cache of
xml files.
2023-02-10 06:40:15 +01:00
LoveIsGrief
83b917a960
nixos/manpages: Explain -I option and how to build manpages
When running nixos-rebuild -I, the man page just said "-I path" which could be interpreted as
 "just a path to nixpkgs", which in fact it actually has the same meaning as NIX_PATH.

This is now made clear in the manual, so that when grepping "-I" and "NIX_PATH" one quickly finds
 the format of the option.

I don't know how to link to the "nix manual" as stated in the docbook, so I left that as it is.

Additionally, it wasn't clear to me how to actually build the man pages and view the changes I made.
That's now in the contributing-to-this-manual.chapter.md.
2022-12-11 11:00:06 +01:00
Ryan Mulligan
7501467903 nixos/doc: convert "Contributing to this manual" to CommonMark
Also updates it to mention running md-to-db.sh.
2021-05-22 18:14:49 -07:00