Xavier Delaruelle
bb2c0960ba
doc: clarify hidden module location in modulefile.4
2020-03-29 08:20:49 +02:00
Xavier Delaruelle
dddc4789c1
doc: update deflatest design for default/latest modfile
2020-03-26 12:19:25 +01:00
Xavier Delaruelle
6d3a27b786
doc: add ref to 4.0 closed issues in diff doc
2020-03-09 08:19:50 +01:00
Xavier Delaruelle
01e2f4add1
Add support for NO_COLOR env variable
...
Add support for the NO_COLOR environment variable
(https://no-color.org/ ) which when set (regardess of its value) prevents
the addition of ANSI color.
When set, NO_COLOR prevails over CLICOLOR and CLICOLOR_FORCE environment
variables. MODULES_COLOR overrides these tree variables.
Fixes #310
2020-02-24 06:53:12 +01:00
Xavier Delaruelle
755841fae5
doc: clarify some statements in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
c8ff0cedcb
doc: add refs between sections in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
46332f0237
doc: refer to more generic vers name in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
267f68a969
doc: simplify reading of compiler-etc-depend recipe (code)
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
2c7be3d319
doc: improve console output reading of compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
aa8feb115b
doc: adopt neutral tone compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
529bca1bbf
doc: add ref to ext tools mentionned in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
d3e29f4fa9
doc: normalize rst section/link syntax in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
cc276e4e15
doc: fix typos in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
410bd79d5e
doc: normalize code of modulefile of compiler-etc-depend recipe
...
And include these modulefile examples as Tcl code in recipe document to
get their content highlighted.
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
996c1ddc21
doc: normalize code of Tcl lib of compiler-etc-depend recipe
...
Add authorship information, same header and comment structure for all
Tcl files to include these files in cookbook recipe document with Tcl
syntax highlight.
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
cd1de48da8
doc: fix broken refs in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
e451b7754c
doc: simplify reading of compiler-etc-depend recipe (dummy)
2020-02-21 22:41:46 +01:00
Tom Payerle
f2272eb917
doc: add compiler-etc-dependencies cookbook recipe
...
New cookbook discussing various strategies for creating modulefiles for
packages with multiple builds depending on previously loaded compiler,
MPI libraries etc. (E.g. handling different "flavors" of packages)
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
c26a212abd
doc: reorganize documentation index
2020-01-18 12:29:37 +01:00
Xavier Delaruelle
7eb91c142d
doc: transform INSTALL-win.txt into INSTALL-win.rst
2020-01-17 21:39:22 +01:00
Xavier Delaruelle
f6c72a0223
doc: desc. -j/--json option in diff/man
2020-01-09 20:59:31 +01:00
Xavier Delaruelle
39658239d7
doc/rpm: add ml man page
2020-01-09 20:38:50 +01:00
Xavier Delaruelle
c3ac4c45d7
doc: desc ml in man/diff/INSTALL
2020-01-09 20:38:50 +01:00
Xavier Delaruelle
76fabfecef
doc: add default-latest-version-specifiers design notes
2020-01-09 20:38:50 +01:00
Xavier Delaruelle
2a43a7b7ea
doc: alphabetically sort sub-cmds, opts and envar in module.1
2020-01-09 07:09:48 +01:00
Xavier Delaruelle
60975540d6
doc: alphabetically sort modulefile cmds in modulefile.4
2020-01-09 07:09:48 +01:00
Xavier Delaruelle
dbeaeaa48b
doc: apply same markup on diff doc than man pages
2020-01-09 07:09:48 +01:00
Xavier Delaruelle
76072dc26a
doc: split lines larger than 78 cols in man pages
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
6d47720745
doc: desc. modulefile cmd version addition in modulefile.4
2020-01-08 23:07:23 -07:00
Colin Marquardt
a555a75504
doc: desc. env var version addition in module.1
2020-01-08 23:07:23 -07:00
Colin Marquardt
fcdc169881
doc: desc. sub-cmds version addition in module.1
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
be9e6f013a
doc: desc. cmd line switches version addition in module.1
2020-01-08 23:07:23 -07:00
Colin Marquardt
8c7f0c0a3d
doc: markup code with double backticks in man pages
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
882f4ee763
doc: fix missing ref link in or between man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
68eac641fb
doc: markup modulefile cmd with :mfcmd: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
a4ae6f1b62
doc: markup modulefile cmd sections with .. mfcmd:: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
c05c510da0
doc: markup subcmd with :subcmd: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
5f254d8a4a
doc: markup subcmd sections with .. subcmd:: in man pages
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
a9d17aa0cc
doc: add sphinx directives/roles for sub-cmd and modulefile cmd
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
a314e8530b
doc: markup autogen files with :file: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
2869d5781a
doc: markup option sections with .. option:: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
ca6145cb05
doc: markup cmd opt with :option: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
f72b67e774
doc: markup env var with :envvar: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
42cdd9dbdf
doc: markup env var sections with .. envar:: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
2849d06c2b
doc: markup cmds with :command: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
7b6ec26eaa
doc: markup man page ref with :manpage: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
cce5135e89
doc: markup files with :file: in man pages
2020-01-08 23:07:23 -07:00
Colin Marquardt
df8f44e7a2
doc: fix ref link to Locating Modulefiles section
2020-01-08 23:07:23 -07:00
Colin Marquardt
9b2cad1d7d
doc: highlight code included in cookbook recipes
...
Specify language directive for included Tcl script files in cookbook
recipes to get their code highlighted in resulting HTML documents. As
Pygment Tcl lexer used by Sphinx does not support the whole Tcl syntax,
scripts of modulepaths-persist-over-sudo and test-modulefiles recipes
have been adapted to enable highlighting. Change has not been performed
over the expose-procs-vars-to-modulefiles and top-priority-values
recipes as their code cannot be adapted to match lexer needs.
2020-01-08 23:07:23 -07:00
Colin Marquardt
1485f9da81
doc: fix some typos and grammar across documents
2020-01-08 23:07:23 -07:00
