diff --git a/README.md b/README.md index 202ae3ee7..8ffbbb49f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -* NeXus: http://www.nexusformat.org/ +* NeXus: https://www.nexusformat.org/ * citation: [![DOI](https://zenodo.org/badge/19377430.svg)](https://zenodo.org/badge/latestdoi/19377430) (DOI: 10.5281/zenodo.1472392) -* documentation: http://download.nexusformat.org/doc/html/index.html +* documentation: https://manual.nexusformat.org/ * Release Notes: https://github.com/nexusformat/definitions/wiki/Release-Notes * build server: http://build.nexusformat.org/ * travis-ci: syntax check of every NXDL file [![Build Status](https://travis-ci.org/nexusformat/definitions.svg)](https://travis-ci.org/nexusformat/definitions) diff --git a/impatient-guide/index.rst b/impatient-guide/index.rst index aeb9f97e8..dfc630557 100644 --- a/impatient-guide/index.rst +++ b/impatient-guide/index.rst @@ -13,9 +13,9 @@ Why NeXus? .. seealso:: This document is available online in - `HTML `_ + `HTML `_ and - `PDF `_ + `PDF `_ formats. The NeXus data format [#NeXus]_ is a tool which has been designed to @@ -444,8 +444,7 @@ Any program whose aim is to identify plottable data should use the following pro #. Plot the *signal* data, given *axes* and *AXISNAME_indices*. -For details of this process, consult this -`section `_ +For details of this process, consult this :ref:`section` of the NeXus manual. [#v3]_ @@ -692,7 +691,7 @@ More Information ================ Did we get you interested? Here is where you can get more information. -Our main entry point is the NeXus WWW-site at http://www.nexusformat.org +Our main entry point is the NeXus WWW-site at https://www.nexusformat.org/ where you can find more information, download the NeXus API, NeXus User Manual [#Manual]_ and NeXus Reference Documentation. [#RefDoc]_ @@ -717,7 +716,7 @@ which meets once a year. The NIAC strives to have a representative for each participating facility. The NIAC has a constitution which you can find on the NeXus WWW site. -.. [#NeXus] NeXus: http://www.nexusformat.org/ +.. [#NeXus] NeXus: https://www.nexusformat.org/ .. shameless self-promotion @@ -729,10 +728,8 @@ find on the NeXus WWW site. http://svn.nexusformat.org/definitions/exampledata/IPNS/LRMECS/lrcs3701.nx5 .. [#Manual] NeXus User Manual: - http://download.nexusformat.org/doc/html/UserManual.html + :ref:`NeXus User Manual` -.. [#RefDoc] NeXus Reference Documentation: - http://download.nexusformat.org/doc/html/ReferenceDocumentation.html +.. [#RefDoc] :ref:`NeXus Reference Documentation` -.. [#v3] Finding the plottable data: - http://download.nexusformat.org/doc/html/datarules.html#version-3 +.. [#v3] :ref:`Finding the plottable data` diff --git a/jenkins_build b/jenkins_build index 55089ea90..0770c7ec9 100755 --- a/jenkins_build +++ b/jenkins_build @@ -1,7 +1,6 @@ #!/bin/sh set -o errexit -x - # jenkins job name job_name="$1" @@ -49,16 +48,16 @@ if test "${job_name}" = "master branch"; then ( cd impatient-guide && cp -f _build/latex/NXImpatient.pdf ${WWW_ROOT}/doc/NXImpatient.pdf && rm -rf ${WWW_ROOT}/doc/impatient && cp -rf _build/html ${WWW_ROOT}/doc/impatient ) - -fi ## new gh-pages stuff - rm -fr dist - - git clone https://github.com/nexusformat/definitions.git --branch gh-pages dist export DIST_ROOT=`pwd`/dist - rm -fr dist/* + rm -fr $(DIST_ROOT) + git clone https://github.com/nexusformat/definitions.git --branch gh-pages $(DIST_ROOT) + rm -fr $(DIST_ROOT)/* + + mkdir $(DIST_ROOT)/pdf + cd manual cd source @@ -69,18 +68,20 @@ fi cd build #pdf - cp -f latex/nexus.pdf ${DIST_ROOT}/NeXusManual.pdf + cp -f latex/nexus.pdf ${DIST_ROOT}/pdf/NeXusManual.pdf #html cp -fr html/* ${DIST_ROOT} cd ../../.. - ( cd impatient-guide && cp -f _build/latex/NXImpatient.pdf ${DIST_ROOT}/NXImpatient.pdf && cp -rf _build/html ${DIST_ROOT}/impatient ) + ( cd impatient-guide && cp -f _build/latex/NXImpatient.pdf ${DIST_ROOT}/pdf/NXImpatient.pdf && cp -rf _build/html/* ${DIST_ROOT}/impatient ) cd ${DIST_ROOT} git add . git commit -m "Update docs" git push origin gh-pages +fi + exit 0 diff --git a/legacy_docs/README.md b/legacy_docs/README.md index fedcc3880..96333d1e8 100644 --- a/legacy_docs/README.md +++ b/legacy_docs/README.md @@ -1,6 +1,6 @@ # Legacy versions of NeXus definitions documentation -Per the [NeXus release procedure](http://download.nexusformat.org/doc/html/installation.html?highlight=semantic#nexus-definitions), +Per the [NeXus release procedure](http://manual.nexusformat.org/installation.html?highlight=semantic#nexus-definitions), this directory contains legacy copies of the PDF rendition of the NeXus definitions documentation. (Retaining multiple versions of the HTML would become tedious and clutter the current repository.) diff --git a/manual/source/_templates/google_search.html b/manual/source/_templates/google_search.html index dfb4bc7dd..c711db8bb 100644 --- a/manual/source/_templates/google_search.html +++ b/manual/source/_templates/google_search.html @@ -22,7 +22,7 @@

{{ _('Google search') }}

global NeXus manual
diff --git a/manual/source/community.rst b/manual/source/community.rst index 768fd075f..588bf54c8 100644 --- a/manual/source/community.rst +++ b/manual/source/community.rst @@ -35,7 +35,7 @@ NeXus Webpage ============= First of all, there is the NeXus webpage, -http://www.nexusformat.org/, +https://www.nexusformat.org/, which provides all kinds of information, including membership, minutes, and discussions from the meetings of the NIAC, Code Camps, and Tele Conferences, as well as some proposed designs for consideration by NeXus. diff --git a/manual/source/copyright.rst b/manual/source/copyright.rst index 934c0c140..5e1351766 100644 --- a/manual/source/copyright.rst +++ b/manual/source/copyright.rst @@ -7,7 +7,7 @@ Copyright and Licenses .. index:: license, copyright Published by NeXus International Advisory Committee, -http://www.nexusformat.org +https://www.nexusformat.org Copyright (C) 1996-2018 NeXus International Advisory Committee (NIAC) diff --git a/manual/source/datarules.rst b/manual/source/datarules.rst index 4a2e54c3c..0af9206e4 100644 --- a/manual/source/datarules.rst +++ b/manual/source/datarules.rst @@ -863,12 +863,12 @@ is specified using attributes attached to the :ref:`NXdata` group. "strict writer, liberal reader". .. [#] Summary of the discussion at NIAC2014 to revise how to find default data: - http://www.nexusformat.org/2014_How_to_find_default_data.html + https://www.nexusformat.org/2014_How_to_find_default_data.html .. [#aa] Note on array attributes: Attributes potentially containing multiple values (axes and _indices) are to be written as string or integer arrays, to avoid string parsing in reading applications. -.. [#axes] NIAC2014 proposition: http://www.nexusformat.org/2014_axes_and_uncertainties.html +.. [#axes] NIAC2014 proposition: https://www.nexusformat.org/2014_axes_and_uncertainties.html Examples @@ -1020,7 +1020,7 @@ attribute for the other scales is optional. .. 2016-01-23,PRJ: not necessary Perhaps substitute with the discussion from NIAC2014? - http://www.nexusformat.org/2014_axes_and_uncertainties.html + https://www.nexusformat.org/2014_axes_and_uncertainties.html .. _Design-Linking-Discussion: diff --git a/manual/source/design.rst b/manual/source/design.rst index 53985f556..ecda45d0d 100644 --- a/manual/source/design.rst +++ b/manual/source/design.rst @@ -378,7 +378,7 @@ a URL to a group in another file. More information about the ``@napimount`` attribute is described in the *NeXus Programmers Reference*. [#]_ -.. [#] http://download.nexusformat.org/doc/NeXusIntern.pdf +.. [#] https://manual.nexusformat.org/pdf/NeXusIntern.pdf .. index:: link; external file, NeXus link diff --git a/manual/source/examples/NX__template__.nxdl.xml b/manual/source/examples/NX__template__.nxdl.xml index f99779494..a98fb9dc4 100755 --- a/manual/source/examples/NX__template__.nxdl.xml +++ b/manual/source/examples/NX__template__.nxdl.xml @@ -18,7 +18,7 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # -# For further information, see http://www.nexusformat.org +# For further information, see https://www.nexusformat.org/ --> `_. + adoption status on the `Facilities web page `_. Please have a look at this list. Keep in mind that it is never fully complete or up to date. #. NeXus files are binary? This is crazy! How am I supposed to see my data? @@ -78,7 +78,7 @@ This is a list of commonly asked questions concerning the NeXus data format. If you encounter any problems because the classes are not sufficient to describe your experiment, please contact the - `mailing list `_. + :ref:`mailing list`. Pull requests for the defintions repository (for example adding contributed defintions) are also welcome (see next question). The NIAC is always willing to consider new proposals. @@ -88,7 +88,7 @@ This is a list of commonly asked questions concerning the NeXus data format. Read the :index:`NXDL` Tutorial in :ref:`NXDL_Tutorial-CreatingNxdlSpec` and have a try. You can ask for help on the - `mailing lists `_. + :ref:`mailing lists`. Once you have a definition that is working well for at least your case, you can submit it to the NIAC for acceptance as a standard. The procedures for acceptance are defined in the NIAC :index:`constitution`. [#]_ @@ -97,7 +97,7 @@ This is a list of commonly asked questions concerning the NeXus data format. .. [#] Refer to the most recent version of the NIAC constitution on the NIAC web page: - http://www.nexusformat.org/NIAC.html#constitution + https://www.nexusformat.org/NIAC.html#constitution #. What is the purpose of ``NXdata``? diff --git a/manual/source/history.rst b/manual/source/history.rst index 0afdebaac..456d016b3 100644 --- a/manual/source/history.rst +++ b/manual/source/history.rst @@ -33,7 +33,7 @@ Two things to note about the development and history of NeXus: and the NXentry and NXdata groups. See the description in :ref:`Design-FindPlottable-NIAC2014` and the proposal: - http://www.nexusformat.org/2014_How_to_find_default_data.html + https://www.nexusformat.org/2014_How_to_find_default_data.html 2012-05: first release (3.1.0) of NXDL (NeXus Definition Language) @@ -145,13 +145,13 @@ Two things to note about the development and history of NeXus: for the European neutron scattering community while working at ISIS -.. [#NeXus_Proposal] http://www.nexusformat.org/pdfs/NeXus_Proposal.pdf +.. [#NeXus_Proposal] https://www.nexusformat.org/pdfs/NeXus_Proposal.pdf .. [#softness] http://www.neutron.anl.gov/softness -.. [#aps] http://www.nexusformat.org/pdfs/Proposed_Data_Standard_for_the_APS.pdf +.. [#aps] https://www.nexusformat.org/pdfs/Proposed_Data_Standard_for_the_APS.pdf -.. [#netCDF] http:/wwww.nexusformat.org/pdfs/European-Formats.pdf +.. [#netCDF] https://www.nexusformat.org/pdfs/European-Formats.pdf .. comment from here moved to file: history-unpublished-comment.txt diff --git a/manual/source/index.rst b/manual/source/index.rst index 923576ddb..27daa651d 100644 --- a/manual/source/index.rst +++ b/manual/source/index.rst @@ -5,7 +5,7 @@ User Manual and Reference Documentation ======================================= -http://www.nexusformat.org/ +https://www.nexusformat.org/ .. toctree:: :maxdepth: 2 @@ -32,19 +32,19 @@ This manual built |today|. This document is available in these formats online: :HTML: - http://download.nexusformat.org/doc/html/index.html + https://manual.nexusformat.org/ :PDF: - http://download.nexusformat.org/doc/NeXusManual.pdf + https://manual.nexusformat.org/pdf/NeXusManual.pdf A very brief overview (title: *NeXus for the Impatient*) is also available (separate from the manual). :HTML: - http://download.nexusformat.org/doc/impatient + https://manual.nexusformat.org/impatient/ :PDF: - http://download.nexusformat.org/doc/NXImpatient.pdf + https://manual.nexusformat.org/pdf/NXImpatient.pdf .. Suggestions for adding to this manual: diff --git a/manual/source/installation.rst b/manual/source/installation.rst index 1ad6a14b3..10a61142b 100644 --- a/manual/source/installation.rst +++ b/manual/source/installation.rst @@ -157,8 +157,7 @@ state of the NeXus standard). Each new *release* of the definitions will be posted to the definitions GitHub repository and announced to the community via the -NeXus mailing list: ``nexus@nexusformat.org`` -(http://download.nexusformat.org/doc/html/mailinglist.html#nexus-mailing-list) +NeXus mailing list: :ref:`nexus@nexusformat.org` NeXus definitions ================= diff --git a/manual/source/mailinglist.rst b/manual/source/mailinglist.rst index 4d19f4626..1df09e694 100644 --- a/manual/source/mailinglist.rst +++ b/manual/source/mailinglist.rst @@ -37,7 +37,7 @@ NeXus Video Conference Announcements ==================================== There are video conferences on NeXus roughly twice a month. -Agenda and joining details are posted on the webpage: http://www.nexusformat.org/Teleconferences.html +Agenda and joining details are posted on the webpage: https://www.nexusformat.org/Teleconferences.html In addition calendar invites are sent to this list. NeXus-Tech used to be used for discussions in the past. Now the list is moderated to only allow communication related to holding meetings. All other traffic should go to the main list nexus@nexusformat.org diff --git a/manual/source/napi.rst b/manual/source/napi.rst index e21546042..bb12e1d36 100644 --- a/manual/source/napi.rst +++ b/manual/source/napi.rst @@ -239,4 +239,4 @@ Reporting Bugs in the NeXus API If you encounter any bugs in the installation or running of the NeXus API, please report them online using our Issue Reporting system. -(http://www.nexusformat.org/IssueReporting.html) +(https://www.nexusformat.org/IssueReporting.html) diff --git a/manual/source/niac.rst b/manual/source/niac.rst index 58d44db62..044711a35 100644 --- a/manual/source/niac.rst +++ b/manual/source/niac.rst @@ -52,5 +52,5 @@ plan: .. [#] For more details about the NIAC :index:`constitution`, procedures, and meetings, refer to - the NIAC web page: http://www.nexusformat.org/NIAC.html + the NIAC web page: https://www.nexusformat.org/NIAC.html The members of the NIAC may be reached by email: nexus-committee@nexusformat.org