doc: add "Developer HowTos" section on doc website

envmodules · Dec 17, 2024 · e61d40a · e61d40a
1 parent 5ca02ad
commit e61d40a
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 4 deletions.
diff --git a/.hunspell.en.dic b/.hunspell.en.dic
@@ -1205,3 +1205,4 @@ nb
 2d
 envmodules
 lightsteelblue
+HowTos
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -71,11 +71,11 @@ Start coding
 .. _create a pull request: https://help.github.com/articles/creating-a-pull-request/
 .. _Tcl 8.5 commands reference: https://www.tcl-lang.org/man/tcl8.5/TclCmd/contents.htm
 
-Design notes
-~~~~~~~~~~~~
+Developer notes
+~~~~~~~~~~~~~~~
 
-See the :ref:`design` for recent feature specifications. You may also find
-there some development howtos:
+See the :ref:`design` for recent feature specifications. Some development
+howtos are also available:
 
 * :ref:`add-new-sub-command`
 * :ref:`add-new-config-option`

diff --git a/NEWS.rst b/NEWS.rst
@@ -21,6 +21,8 @@ Modules 5.6.0 (not yet released)
 * Update repository URL to https://github.com/envmodules/modules.
 * Install: update :file:`configure` script to allow running it from a current
   working directory different than where this file is stored. (fix issue #558)
+* Doc: create *Developer HowTos* section on documentation website to group
+  development how-to guides.
 
 .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
 

diff --git a/doc/source/devel.rst b/doc/source/devel.rst
@@ -0,0 +1,13 @@
+.. _devel:
+
+Developer HowTos
+================
+
+Developer guides to implement new command, option, etc or draft a new release
+of Modules.
+
+..  toctree::
+    :maxdepth: 1
+    :glob:
+
+    devel/*
diff --git a/doc/source/design/add-new-config-option.rst → doc/source/devel/add-new-config-option.rst b/doc/source/design/add-new-config-option.rst → doc/source/devel/add-new-config-option.rst
diff --git a/doc/source/design/add-new-sub-command.rst → doc/source/devel/add-new-sub-command.rst b/doc/source/design/add-new-sub-command.rst → doc/source/devel/add-new-sub-command.rst
diff --git a/doc/source/design/create-new-release.rst → doc/source/devel/create-new-release.rst b/doc/source/design/create-new-release.rst → doc/source/devel/create-new-release.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -117,6 +117,7 @@ automatically configured to the correct architecture.
    :caption: Development
 
    CONTRIBUTING
+   devel
    design
-Original file line number
+Diff line change
@@ Expand Up / @@ -1205,3 +1205,4 @@ nb @@
 d
     envmodules
     lightsteelblue
+    HowTos