Skip to content

Commit e61d40a

Browse files
committed
doc: add "Developer HowTos" section on doc website
1 parent 5ca02ad commit e61d40a

File tree

8 files changed

+21
-4
lines changed

8 files changed

+21
-4
lines changed

.hunspell.en.dic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1205,3 +1205,4 @@ nb
12051205
2d
12061206
envmodules
12071207
lightsteelblue
1208+
HowTos

CONTRIBUTING.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ Start coding
7171
.. _create a pull request: https://help.github.com/articles/creating-a-pull-request/
7272
.. _Tcl 8.5 commands reference: https://www.tcl-lang.org/man/tcl8.5/TclCmd/contents.htm
7373

74-
Design notes
75-
~~~~~~~~~~~~
74+
Developer notes
75+
~~~~~~~~~~~~~~~
7676

77-
See the :ref:`design` for recent feature specifications. You may also find
78-
there some development howtos:
77+
See the :ref:`design` for recent feature specifications. Some development
78+
howtos are also available:
7979

8080
* :ref:`add-new-sub-command`
8181
* :ref:`add-new-config-option`

NEWS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Modules 5.6.0 (not yet released)
2121
* Update repository URL to https://github.com/envmodules/modules.
2222
* Install: update :file:`configure` script to allow running it from a current
2323
working directory different than where this file is stored. (fix issue #558)
24+
* Doc: create *Developer HowTos* section on documentation website to group
25+
development how-to guides.
2426

2527
.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
2628

doc/source/devel.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _devel:
2+
3+
Developer HowTos
4+
================
5+
6+
Developer guides to implement new command, option, etc or draft a new release
7+
of Modules.
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
:glob:
12+
13+
devel/*
File renamed without changes.

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ automatically configured to the correct architecture.
117117
:caption: Development
118118

119119
CONTRIBUTING
120+
devel
120121
design
121122

122123

0 commit comments

Comments
 (0)