From 3e3c4529676adcb1ae44eb01bc885f47371e5833 Mon Sep 17 00:00:00 2001 From: Tieqiong <123656525+Tieqiong@users.noreply.github.com> Date: Tue, 20 Aug 2024 10:30:30 -0400 Subject: [PATCH] use download for document files (#180) --- doc/source/index.rst | 4 ++-- doc/source/tutorial.rst | 12 +++++------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index f60279c9..4821eb80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,8 +17,8 @@ or neutron diffraction data and comes with built in graphical and structure visualization capabilities. PDFgui is a friendly interface to the PDFfit2 refinement engine, with many -powerful extensions. To get started, please open the `manual <../../manual/pdfgui.html>`_ -from the help menu or follow the `tutorial instructions `_. +powerful extensions. To get started, please open the manual (:download:`html <../manual/pdfgui.html>` +/:download:`pdf <../manual/pdfgui.pdf>`) from the help menu or follow the :ref:`quick_start`. ======= Authors diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index d8a1c035..ab3d7002 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -1,6 +1,4 @@ -:tocdepth: -1 - -.. index:: tutorial +.. _quick_start: Tutorial ######## @@ -15,8 +13,8 @@ Lesson 1: Creating simple fit of Ni PDF Input files: -* `Ni-xray.gr <../../tutorial/Ni-xray.gr>`_ - experimental X-ray PDF data -* `Ni.stru <../../tutorial/Ni.stru>`_ - Ni f.c.c. structure in PDFfit format +* :download:`Ni-xray.gr <../tutorial/Ni-xray.gr>` - experimental X-ray PDF data +* :download:`Ni.stru <../tutorial/Ni.stru>` - Ni f.c.c. structure in PDFfit format Procedure: @@ -136,8 +134,8 @@ Learn how to string together fits. References ========== -1. `(pdf) <../../manual/Proffen-jac-1999.pdf>`_, +1. :download:`(pdf) <../manual/Proffen-jac-1999.pdf>`, Th. Proffen and S. J. L. Billinge, PDFFIT a program for full profile structural refinement of the atomic pair distribution function, J. Appl. Crystallogr. 32, 572-575 (1999) -2. `(pdf) <../../manual/Farrow-jpcm-2007.pdf>`_, +2. :download:`(pdf) <../manual/Farrow-jpcm-2007.pdf>`, C. L. Farrow, P. Juhas, J. W. Liu, D. Bryndin, J. Bloch, Th. Proffen and S. J. L. Billinge, PDFfit2 and PDFgui: Computer programs for studying nanostructure in crystals, J. Phys.: Condens. Matter 19, 335219 (2007)