Skip to content

Commit f5ec9d3

Browse files
committed
Merge branch 'master' of github.com:vincefn/objcryst
* 'master' of github.com:vincefn/objcryst: Remove sphinx-objcryst/Makefile not required for readthedocs Update doc Update doc Update doc generation with basic fake sphinx config
2 parents e62f3fb + 5e20ee2 commit f5ec9d3

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

ObjCryst/doc/.readthedocs.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ build:
99
jobs:
1010
post_build:
1111
- cd ObjCryst/doc && doxygen
12-
- cp -Rf ObjCryst/doc/build/html/ "$READTHEDOCS_OUTPUT/html/"
12+
- mv ObjCryst/doc/build/html/* "$READTHEDOCS_OUTPUT/html/"
13+
sphinx:
14+
configuration: ObjCryst/doc/sphinx-objcryst/conf.py

ObjCryst/doc/doc-main.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,14 @@ namespace ObjCryst
116116
* these are the cctbx and newmat package. You should
117117
* refer to the documentation and legal notes included in their respective directories:
118118
*\par
119-
* <a href="newmat.htm">The newmat matrix library</a> (Robert B Davies).
119+
* <a href="https://github.com/rzr/newmat">The newmat matrix library</a> (Robert B Davies).
120120
* This library is only used
121-
* for matrix SVD decomposition and inversion in Least Squares methods (Least Squares
122-
* method was written only for tests purposes... Don't expect anything from it...).
121+
* for matrix SVD decomposition and inversion in Least Squares methods.
123122
*\par
124123
* <a href="https://cctbx.github.io/">The cctbx library</a>(Ralf Grosse-Kunstleve).
125124
* This library is used to determine the atomic scattering factors for X-Ray,
126125
* neutrons, as well as anomalous scattering factors and the atomic number,
127-
* and for all spacegroup interpretation.
126+
* and for all spacegroup/symmetry interpretation.
128127
*\par
129128
*
130129
*/

ObjCryst/doc/sphinx-objcryst/conf.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Minimal sphinx config - not actually used for ObjCryst,
2+
# this is just necessary for readthedocs to be happy
3+
4+
# Configuration file for the Sphinx documentation builder.
5+
#
6+
# For the full list of built-in configuration values, see the documentation:
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
8+
9+
# -- Project information -----------------------------------------------------
10+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
11+
12+
project = 'ObjCryst++'
13+
copyright = '2024, Vincent Favre-Nicolin'
14+
author = 'Vincent Favre-Nicolin'
15+
release = '2022.1'

ObjCryst/doc/sphinx-objcryst/index.rst

Whitespace-only changes.

0 commit comments

Comments
 (0)