Skip to content

Commit d3e151a

Browse files
committed
docs: remove documentation template and add QPA notebook in the documentation
1 parent 20799ab commit d3e151a

File tree

4 files changed

+29
-93
lines changed

4 files changed

+29
-93
lines changed

docs/source/examples/examples.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Example notebooks
55
Several examples available in the pyobjcryst repository:
66

77
:doc:`3D Crystal structure display <crystal_3d_widget>`
8-
================================================================
8+
=======================================================
99

1010
Example of importing a CIF file from a file or the
1111
`Crystallography Open Database <http://crystallography.net/cod/>`_
1212
and displaying it in a widget using
1313
`3dmol.js <https://3dmol.csb.pitt.edu/>`_.
1414

1515
:doc:`Solving the cimetidine structure from its powder pattern <structure-solution-powder-cimetidine>`
16-
===============================================================================================================
16+
======================================================================================================
1717

1818
In this example, a powder pattern is used to solve the crystal
1919
structure of Cimetidine. This covers all the steps: loading the
@@ -22,7 +22,7 @@ the spacegroup, profile fitting, and solving the structure
2222
using a global optimisation algorithm.
2323

2424
:doc:`Solving the PbSO4 structure from its X and N powder patterns <structure-solution-powder-pbso4>`
25-
==============================================================================================================
25+
=====================================================================================================
2626

2727
In this example, two powder patterns (X-ray and neutron) are used to solve
2828
the crystal structure of PbSO4. This covers all the steps: loading the
@@ -31,14 +31,14 @@ the spacegroup, profile fitting for the two patterns, and solving the
3131
structure using a global optimisation algorithm.
3232

3333
:doc:`Meta-structure solution using multi-processing <structure-solution-multiprocessing>`
34-
===================================================================================================
34+
==========================================================================================
3535

3636
This is a more advanced example where 8 different spacegroups are
3737
tested in parallel to determine which one is correct. The solutions
3838
can then be compared and displayed individually.
3939

40-
:doc:`Quantitative phase analysis (QPA) <Quantitative-phase-analysis>`
41-
===============================================================================
40+
:doc:`Quantitative phase analysis (QPA) <QPA-Quantitative phase analysis>`
41+
==========================================================================
4242

4343
Example of QPA based on the data available from the `1999 Round Robin
4444
<https://www.iucr.org/__data/iucr/powder/QARR/samples.htm>`_,

docs/source/getting-started.rst

Lines changed: 0 additions & 79 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,6 @@
99
| Software version |release|
1010
| Last updated |today|.
1111
12-
===============
13-
Getting started
14-
===============
15-
16-
Welcome to the ``pyobjcryst`` documentation!
17-
18-
To get started, please visit the :ref:`Getting started <getting-started>` page.
19-
2012
=======
2113
Authors
2214
=======

news/remove-template.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: Remove the documentation template and add QPA notebook in docuementation.
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)