Commit Graph

342 Commits

Author SHA1 Message Date
Xavier Delaruelle
76e4d10d16 doc: desc. module-info usergroups/username in modulefile(4) 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
16368cfc32 doc: reorder module-info sub-cmd desc. in modulefile(4) 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
eb4e830590 doc: desc. module-info username/usergroups in diff doc 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
44c9147ee8 Apply inclusive terminology in code and docs
Use inclusive terminology [1] to eliminate 'master' and 'slave' terms as
much as possible from code and documentation. 'master' has been changed
into 'main' and 'slave' into 'subordinate' or 'sub'.

After this change, some references to the 'master' and 'slave' word can
still be found in repository:
* `slaves` sub-command of `interp` Tcl command
* `--slave` option of `update-alternatives tool in RPM spec file
* `master_doc` attribute of Sphinx `conf.py` file
* git 'master' branch need to be renamed and tools referring it need to
  be updated accordingly (configure, script/mpub, script/mrel)

[1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=49decddd39e5f6132ccd7d9fdc3d7c470b0061bb
2020-07-16 21:31:30 +02:00
Xavier Delaruelle
a44f1fd195 doc: use brighter variation of red svg logo
Built from CMYK EPS file.
2020-06-27 08:27:40 +02:00
Xavier Delaruelle
b0d2fe921c doc: fix html theme on RTD
To avoid RTD to override html_theme_options when html_theme is set to
'default'.
2020-06-24 08:03:58 +02:00
Xavier Delaruelle
fd7ba8de87 doc: include logo in doc portal 2020-06-24 07:50:09 +02:00
Xavier Delaruelle
d15b7c6494 doc: add source-script-in-modulefile recipe 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
fcc2a32686 doc: desc. source-sh/MODULES_LMSOURCESH in man/diff 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
98846cd6b1 doc: desc. env recording in source-sh design doc 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
227f325ea7 doc: desc. -T/--trace in man/diff/INSTALL docs 2020-06-01 21:02:32 +02:00
Xavier Delaruelle
31fadd19a8 doc: desc. sh-to-mod in module(1) and diff docs 2020-06-01 20:59:50 +02:00
Xavier Delaruelle
2351c9a863 doc: add source-shell-script-in-modulefile design doc 2020-06-01 20:59:50 +02:00
Xavier Delaruelle
69d149e314 doc: desc. default/latest auto symbols in man pages 2020-04-07 15:11:12 +02:00
Xavier Delaruelle
24be4294ee doc: refine default/latest vers spec design 2020-04-07 07:21:27 +02:00
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
f046cd833c doc: simplify reading of compiler-etc-depend recipe (trailing space) 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
ed38a98c6c install: need sphinx if dist does not contain prebuilt doc
Check at configure step if pre-built documents are available, if found
Sphinx-related makefile rules are inhibited. Otherwise Sphinx
availability is tested and documentation build is disabled if not found.
2020-01-31 08:08:24 +01:00
Xavier Delaruelle
ea931f13d3 install: no exclude of doc files from git archive dist
No more exclusion of project-related or installation documents from git
archive distribution. Enable makefile rules relative to Sphinx
documentation build even if not building from git repository. With
release distribution tarballs nothing changes as document is pre-built
in these archives. When working from a `git archive` export, these
Sphinx rules will help to build docs.
2020-01-31 06:39:06 +01:00
Xavier Delaruelle
0a2fbed5e2 install: do not clean ml.1 on 'make clean' if pre-built 2020-01-29 20:31:30 +01:00
Xavier Delaruelle
c26a212abd doc: reorganize documentation index 2020-01-18 12:29:37 +01:00
Xavier Delaruelle
fb77a465ef doc: remove now deprecated using_on_windows howto 2020-01-17 21:49:48 +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