Skip to content

Commit 440e361

Browse files
committed
DOC - move developer discussions into less visible place
1 parent 71e8f9d commit 440e361

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed

doc/source/devdiscuss.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. -*- mode: rst; fill-column: 79 -*-
2+
.. ex: set sts=4 ts=4 sw=4 et tw=79:
3+
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
4+
#
5+
# See COPYING file distributed along with the NiBabel package for the
6+
# copyright and license terms.
7+
#
8+
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
9+
10+
.. _chap_devdiscuss:
11+
12+
*********************
13+
Developer discussions
14+
*********************
15+
16+
Some discussions of usecases and other design issues. Most of these don't apply
17+
to the current codebase, and are only for discussion of future directions.
18+
19+
.. toctree::
20+
:maxdepth: 2
21+
22+
usecases/index
23+
refactoring/index
24+
data_pkg_design

doc/source/devguide.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313
NiBabel Developer Guidelines
1414
****************************
1515

16+
NiBabel source code
17+
===================
18+
1619
.. toctree::
1720
:maxdepth: 2
1821

1922
gitwash/index
20-
refactoring/index
2123

2224
Documentation
2325
=============
@@ -86,10 +88,11 @@ Merges
8688
------
8789

8890
For easy tracking of what changes were absorbed during merge, we
89-
advice to enable merge summary within git:
91+
advise that you enable merge summaries within git:
9092

9193
git-config merge.summary true
9294

95+
See :ref:`configure-git` for more detail.
9396

9497
Changelog
9598
=========

doc/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Documentation
1515
* :ref:`User Documentation <manual>` (manual)
1616
* :ref:`API Documentation <api>` (comprehensive reference)
1717
* :ref:`Developer Guidelines <chap_devguide>` (for those who want to contribute)
18+
* :ref:`Developer discussions <chap_devdiscuss>` (arcane discussions about code
19+
design)
1820
* :ref:`Development Changelog <changelog>` (see what has changed)
1921
* :ref:`genindex` (access by keywords)
2022
* :ref:`search` (online and offline full-text search)

doc/source/manual.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ NiBabel Manual
88

99
installation
1010
gettingstarted
11-
usecases/index
1211
dicom/dicom
1312
legal
1413
changelog

0 commit comments

Comments
 (0)