Skip to content

Commit 3c42edd

Browse files
committed
improve developer's notes
1 parent 42b7663 commit 3c42edd

File tree

3 files changed

+31
-10
lines changed

3 files changed

+31
-10
lines changed

webdocs/developers.rst

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,38 @@
44
:align: right
55

66
======================================
7-
Documentation for GSAS-II Developers
7+
Notes for GSAS-II Developers
88
======================================
99

10-
Note the `documentation web page <documentation.html>`_, as the
11-
"Developer's Documentation" document, available in several formats, is
12-
of very significant value for code development.
10+
We welcome cooperation from people interested in developing or
11+
extending GSAS-II. The code is open source and we are happy to review
12+
submitted code or consider collaborations. The ideal mechanism for
13+
contributions is to clone the
14+
`GitHub repo <https://github.com/AdvancedPhotonSource/GSAS-II>`_ and
15+
then create a pull request, but small changes can be considered via
16+
e-mail.
17+
18+
Note that you can have multiple copies of GSAS-II installed on your
19+
computer so that you can compare running a local development version
20+
against the latest distribution. See the web page on
21+
`Installing GSAS-II for code development <install_dev.html>`_ for more
22+
details.
23+
24+
The Sphinx documentation for the GSAS-II source code will be of
25+
significant value for people attempting to work their way through the
26+
codebase. This is found on the wonderful “Read The Docs” web
27+
site. These documents are available in a number of ways:
28+
29+
* `Access online <https://gsas-ii.readthedocs.io>`_ (HTML)
30+
* `Download as a PDF document
31+
<https://gsas-ii.readthedocs.io/_/downloads/en/latest/pdf/>`_ (~450 pages)
32+
* `Download as an electronic book
33+
<https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_ (Epub format).
1334

1435
If you use any of the self-installer options (gsas2full, gsas2pkg or gitstrap.py), GSAS-II will be installed using https from https://github.com/AdvancedPhotonSource/GSAS-II.git. This is fine for downloading, but to be able to write to the repository, you will probably need to switch to using ssh,
1536
the command for this is::
1637

1738
git remote set-url origin [email protected]:AdvancedPhotonSource/GSAS-II.git
1839

19-
40+
More on this is in the `Installing GSAS-II for code development <install_dev.html>`_
41+
web page, which discusses changing the origin to your forked copy of GSAS-II.

webdocs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ ways to update GSAS-II, as discussed below.
121121

122122
help.rst
123123

124-
Documentation for GSAS-II Developers
124+
Notes for GSAS-II Developers
125125
======================================
126126

127127
We encourage you to improve GSAS-II or to use the code in your own

webdocs/misc.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ In cooperation with the ACA, IUCr, ICDD, LANSCE and NCNR, we celebrated Bob Von
1616

1717
Both pre-recorded videos and live talks were presented. All content was placed on
1818
the American Crystallographic Association's History Portal (via a special `YouTube playlist <https://www.youtube.com/playlist?list=PL9KqEkw6mD5kU1qfJPsScoZTpEnPZIq1E>`_.
19-
Also of note is a short (and fairly modest) autobiographical sketch about Bob's work can be found `in the ACA's History pages <https://history.amercrystalassn.org/robert-von-dreele>`_.
19+
Also of note is a short (and fairly modest) autobiographical sketch
20+
about Bob's work which can also be found `in the ACA's History Portal <https://history.amercrystalassn.org/robert-von-dreele>`_.
2021

21-
Listing of Presentations
22-
23-
.. list-table:: Title
22+
.. list-table:: VonDreeleFest Presentations
2423
:widths: 15 60 15 10
2524
:header-rows: 1
2625

0 commit comments

Comments
 (0)