From e35a0048808c18dfcf50a5a38de728d8dc4b0015 Mon Sep 17 00:00:00 2001 From: BHT Date: Sat, 12 Oct 2024 22:16:00 -0500 Subject: [PATCH] minor tweaks --- webdocs/developers.rst | 4 ++-- webdocs/documentation.rst | 2 +- webdocs/help.rst | 10 +++++++--- webdocs/index.rst | 37 ++++++++++++++++++------------------- webdocs/install.rst | 6 +++--- 5 files changed, 31 insertions(+), 28 deletions(-) diff --git a/webdocs/developers.rst b/webdocs/developers.rst index 09fa1c9..a6de88f 100644 --- a/webdocs/developers.rst +++ b/webdocs/developers.rst @@ -3,9 +3,9 @@ :alt: GSAS-II logo :align: right -==================================== +====================================== Documentation for GSAS-II Developers -==================================== +====================================== Note the `documentation web page `_, as the "Developer's Documentation" document, available in several formats, is diff --git a/webdocs/documentation.rst b/webdocs/documentation.rst index b62a01c..5b25c6b 100644 --- a/webdocs/documentation.rst +++ b/webdocs/documentation.rst @@ -4,7 +4,7 @@ :align: right ==================================== - Available Documentation for GSAS-II +Documentation for GSAS-II Users ==================================== .. index:: GSAS-II tutorials diff --git a/webdocs/help.rst b/webdocs/help.rst index f66c7bb..593b725 100644 --- a/webdocs/help.rst +++ b/webdocs/help.rst @@ -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 diff --git a/webdocs/index.rst b/webdocs/index.rst index 25c4935..d1d2b1b 100644 --- a/webdocs/index.rst +++ b/webdocs/index.rst @@ -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 @@ -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 @@ -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 ==================================== @@ -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 @@ -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: diff --git a/webdocs/install.rst b/webdocs/install.rst index 5bc8e5d..d1c7aa7 100644 --- a/webdocs/install.rst +++ b/webdocs/install.rst @@ -3,9 +3,9 @@ :alt: GSAS-II logo :align: right -==================================== -Choices for GSAS-II Installation -==================================== +============================================ +Overview of GSAS-II Installation Methods +============================================ .. index:: Installation overview