Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

incorporate manual into deploying docs #198

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/manual/extractEquations.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# constants

rc = {
"directory": "images", # output directory
"directory": "../source/images", # output directory
"resolution": 72, # equation images resolution
"eqns": [], # list of raw equation codes
"tmpdir": None, # temporary directory
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/fixHTMLCode.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# constants

rc = {
"directory": "images", # directory with equation images
"directory": "../source/images", # directory with equation images
}

eqmark = "<!-- EquationMark -->"
Expand Down
50 changes: 25 additions & 25 deletions doc/manual/pdfgui.html → doc/manual/html/pdfgui.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions doc/manual/html/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This directory need to be relativly the same as doc/build/html/manual from
doc/source/_static/images
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
5 changes: 3 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 (:download:`html <../manual/pdfgui.html>`
/:download:`pdf <../manual/pdfgui.pdf>`) from the help menu or follow the :ref:`quick_start`.
powerful extensions. To get started, please open the :ref:`manual`
(:download:`pdf <../manual/pdfgui.pdf>`) from the help menu or follow the :ref:`tutorial`.

=======
Authors
Expand Down Expand Up @@ -89,6 +89,7 @@ Table of contents

license
release
manual
Package API <api/diffpy.pdfgui>

=======
Expand Down
16 changes: 16 additions & 0 deletions doc/source/manual.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _manual:

Manual
======

Resources used
--------------

- :download:`Ni data <manual_resources/Ni data.zip>`
- :download:`Temperature data series <manual_resources/Temperature data series.zip>`
- :download:`Doping data series <manual_resources/Doping data series.zip>`
- :download:`tui Mn-O script <manual_resources/tui_mno_bond_lengths.py>`
- :download:`Nanoparticle structure <manual_resources/Nanoparticle structure.zip>`

.. raw:: html
:file: ../manual/html/pdfgui.html
Binary file not shown.
Binary file not shown.
Binary file added doc/source/manual_resources/Ni data.zip
Binary file not shown.
Binary file not shown.
7 changes: 4 additions & 3 deletions doc/source/tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _quick_start:
.. _tutorial:

Tutorial
########
Expand All @@ -13,8 +13,9 @@ Lesson 1: Creating simple fit of Ni PDF

Input files:

* :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
- :download:`Ni data <manual_resources/Ni data.zip>` containing:
1. Ni-xray.gr - experimental X-ray PDF data
2. Ni.stru - Ni f.c.c. structure in PDFfit format

Procedure:

Expand Down
Loading