Skip to content

Commit

Permalink
minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
briantoby committed Oct 13, 2024
1 parent 12126c8 commit e35a004
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 28 deletions.
4 changes: 2 additions & 2 deletions webdocs/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
:alt: GSAS-II logo
:align: right

====================================
======================================
Documentation for GSAS-II Developers
====================================
======================================

Note the `documentation web page <documentation.html>`_, as the
"Developer's Documentation" document, available in several formats, is
Expand Down
2 changes: 1 addition & 1 deletion webdocs/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:align: right

====================================
Available Documentation for GSAS-II
Documentation for GSAS-II Users
====================================

.. index:: GSAS-II tutorials
Expand Down
10 changes: 7 additions & 3 deletions webdocs/help.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
====================================
Help: GSAS-II will not start
====================================

While I hope this never happens again, there have been occasions where a
version of GSAS-II has a bug that prevents the program from starting.
If this version is installed, it is then not possible to access the
version of GSAS-II is placed on the web that has an error that prevents the program from starting.
Once that version is installed, it is then not possible to access the
Help/Update menu command to obtain the different version of
GSAS-II. The same thing can also happen if you make changes to the
files yourself and introduce an error. Also, if you make changes to
the GSAS-II Python (.py) files, you can no longer obtain updates.
the GSAS-II Python (.py) files, you may no longer be able to obtain updates.

A script is provided that can be used to reset any locally made
changes and then install the lastest version of GSAS-II. If you have
Expand Down
37 changes: 18 additions & 19 deletions webdocs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ new features and fixes as they are added and please make sure to use
the latest version before reporting a bug to us, but *please* do report
bugs.

Installation overview
=======================
Overview of GSAS-II Installation Methods
============================================

There are several different ways to install GSAS-II, as are outlined below. Most people will use the GSAS2FULL installer

Expand All @@ -63,7 +63,7 @@ There are several different ways to install GSAS-II, as are outlined below. Most

install.rst

Documentation for Users
Documentation for GSAS-II Users
====================================

While there is no manual for GSAS-II, there is quite a bit of
Expand All @@ -73,19 +73,6 @@ web-based documentation, as listed below.

documentation.rst

Help: GSAS-II will not start
====================================

If there is a bug in GSAS-II, check for updates (using the Help/Update
menu command) and if the bug is present in the latest version, please
report it (see section below on reporting bugs).
Should GSAS-II fail to start after an update, then there are alternate
ways to update GSAS-II, as discussed below.

.. toctree::

help.rst

Mailing List
====================================

Expand All @@ -96,7 +83,7 @@ about what is new and changing.

mailinglist.rst

Reporting Bugs
Reporting GSAS-II Bugs
====================================

If something is not working properly in GSAS-II, please let us
Expand All @@ -119,10 +106,22 @@ used in different parts of the program.

options.rst


Documentation for code developers
Help: GSAS-II will not start
====================================

If there is a bug in GSAS-II, check for updates (using the Help/Update
menu command) and if the bug is present in the latest version, please
report it (see section above on reporting bugs).
Should GSAS-II fail to start after an update, then there are alternate
ways to update GSAS-II, as discussed below.

.. toctree::

help.rst

Documentation for GSAS-II Developers
======================================

We encourage you to improve GSAS-II or to use the code in your own
projects. Some starting information is here:

Expand Down
6 changes: 3 additions & 3 deletions webdocs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
:alt: GSAS-II logo
:align: right

====================================
Choices for GSAS-II Installation
====================================
============================================
Overview of GSAS-II Installation Methods
============================================

.. index:: Installation overview

Expand Down

0 comments on commit e35a004

Please sign in to comment.