Skip to content

Commit

Permalink
Fxi links
Browse files Browse the repository at this point in the history
  • Loading branch information
FreddieAkeroyd committed Jan 22, 2020
1 parent 36bc94e commit 6db2e77
Show file tree
Hide file tree
Showing 18 changed files with 47 additions and 50 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
19 changes: 8 additions & 11 deletions impatient-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Why NeXus?
.. seealso::

This document is available online in
`HTML <http://download.nexusformat.org/doc/impatient>`_
`HTML <https://manual.nexusformat.org/impatient>`_
and
`PDF <http://download.nexusformat.org/doc/NXImpatient.pdf>`_
`PDF <https://manual.nexusformat.org/pdf/NXImpatient.pdf>`_
formats.

The NeXus data format [#NeXus]_ is a tool which has been designed to
Expand Down Expand Up @@ -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 <http://download.nexusformat.org/doc/html/datarules.html#version-3>`_
For details of this process, consult this :ref:`section<Find-Plottable-Data-v3>`
of the NeXus manual. [#v3]_


Expand Down Expand Up @@ -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]_
Expand All @@ -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
Expand All @@ -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<UserManual>`
.. [#RefDoc] NeXus Reference Documentation:
http://download.nexusformat.org/doc/html/ReferenceDocumentation.html
.. [#RefDoc] :ref:`NeXus Reference Documentation<ReferenceDocumentation>`
.. [#v3] Finding the plottable data:
http://download.nexusformat.org/doc/html/datarules.html#version-3
.. [#v3] :ref:`Finding the plottable data<Find-Plottable-Data-v3>`
19 changes: 10 additions & 9 deletions jenkins_build
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/bin/sh
set -o errexit -x


# jenkins job name
job_name="$1"

Expand Down Expand Up @@ -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

Expand All @@ -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
2 changes: 1 addition & 1 deletion legacy_docs/README.md
Original file line number Diff line number Diff line change
@@ -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.)

Expand Down
2 changes: 1 addition & 1 deletion manual/source/_templates/google_search.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h3>{{ _('Google search') }}</h3>
<td align="center" style="font-size:75%">
<input type="radio" name="sitesearch" value="" />global
<input type="radio" name="sitesearch"
value="download.nexusformat.org"
value="manual.nexusformat.org"
checked />NeXus manual
<input type="submit" value="{{ _('Go') }}" />
<br />
Expand Down
2 changes: 1 addition & 1 deletion manual/source/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion manual/source/copyright.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions manual/source/datarules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion manual/source/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion manual/source/examples/NX__template__.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
-->
<definition name="NX__template__" extends="NXobject" type="group"
category="application"
Expand Down
2 changes: 1 addition & 1 deletion manual/source/examples/epics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Footnotes
.. [#] EPICS Area Detector: http://cars9.uchicago.edu/software/epics/areaDetector.html
.. [#] HDF5 File Writer: http://cars9.uchicago.edu/software/epics/NDFileHDF5.html
.. [#] EPICS SimDetector: http://cars9.uchicago.edu/software/epics/simDetectorDoc.html
.. [#] NeXus manual: http://download.nexusformat.org/doc/html/index.html
.. [#] NeXus manual: https://manual.nexusformat.org/
.. [#] caQtDM: http://epics.web.psi.ch/software/caqtdm/
.. [#] h5py: http://docs.h5py.org
.. [#] nexusformat: This Python package is described on the NeXPy web site
Expand Down
8 changes: 4 additions & 4 deletions manual/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is a list of commonly asked questions concerning the NeXus data format.

This is not easy to say, not all facilities using NeXus actively
participate in the committee. Some facilities have reported their
adoption status on the `Facilities web page <http://www.nexusformat.org/Facilities.html>`_.
adoption status on the `Facilities web page <https://www.nexusformat.org/Facilities.html>`_.
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?
Expand Down Expand Up @@ -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 <http://download.nexusformat.org/doc/html/MailingLists.html>`_.
:ref:`mailing list<NeXus.mailinglist.main>`.
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.
Expand All @@ -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 <http://download.nexusformat.org/doc/html/MailingLists.html>`_.
:ref:`mailing lists<NeXus.mailinglist.main>`.
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`. [#]_
Expand All @@ -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``?
Expand Down
8 changes: 4 additions & 4 deletions manual/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions manual/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
User Manual and Reference Documentation
=======================================

http://www.nexusformat.org/
https://www.nexusformat.org/

.. toctree::
:maxdepth: 2
Expand All @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions manual/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.mailinglist.main>`

NeXus definitions
=================
Expand Down
2 changes: 1 addition & 1 deletion manual/source/mailinglist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion manual/source/napi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion manual/source/niac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 6db2e77

Please sign in to comment.