Merge pull request #71 from zmx27/modify-docs

docs: remove skpkg template files and mention of Brookhaven lab in index.rst

Author: sbillinge

README.rst

@@ -101,10 +101,10 @@ displayed in a jupyter notebook:
 
 * a Crystal structure can be displayed in 3D: this requires the
   ``py3dmol`` and ``ipywidgets`` modules. See the notebook
-  ``examples/cystal_3d_widget.ipynb``
+  ``docs/examples/cystal_3d_widget.ipynb``
 * a PowderPattern can be displayed (and live-updated) if
   ``matplotlib`` and ``ipympl`` are installed. See the
-  notebook ``examples/cimetidine-structure-solution-powder.ipynb``
+  notebook ``docs/examples/structure-solution-powder-cimetidine.ipynb``
 
 Getting Started
 ---------------
@@ -143,13 +143,15 @@ module with debug information and C-assertions checks ::
 
 Improvements and fixes are always appreciated.
 
-Before contributing, please read our `Code of Conduct <https://github.com/diffpy/pyobjcryst/blob/main/CODE_OF_CONDUCT.rst>`_.
+Before contributing, please read our `Code of Conduct <https://github.com/diffpy/pyobjcryst/blob/main/CODE-OF-CONDUCT.rst>`_.
 
 Contact
 -------
 
 For more information on pyobjcryst please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at [email protected].
 
+You can also contact Vincent Favre-Nicolin ([email protected]) if you are using pyobjcryst outside diffpy, e.g. to display structures in a notebook, refine powder patterns or solve structures using the global optimisation algorithms, etc..
+
 Acknowledgements
 ----------------
 

docs/source/conf.py

@@ -343,7 +343,7 @@ def setup(app):
         "pyobjcryst Documentation",
         ab_authors,
         "pyobjcryst",
-        "One line description of project.",
+        "Python bindings to the ObjCryst++ library.",
         "Miscellaneous",
     ),
 ]

docs/source/img/scikit-package-logo-text.png

@@ -15,8 +15,7 @@ Authors
 
 `pyobjcryst` was written as part of the DANSE_ open-source project by
 Christopher Farrow, Pavol Juhás, and Simon J.L. Billinge.
-The sources are maintained as a part of the DiffPy-CMI complex
-modeling initiative at the Brookhaven National Laboratory.
+The sources are maintained as a part of the `diffpy` project.
 The underlying library  `ObjCryst++ <https://github.com/vincefn/objcryst>`_
 was developed by V. Favre-Nicolin as part of the development of the
 `Fox <http://fox.vincefn.net>`_ software.

docs/source/index.rst

@@ -57,9 +57,6 @@ include = ["*"]  # package names should match these glob patterns (["*"] by defa
 exclude = []  # exclude packages matching these glob patterns (empty by default)
 namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
 
-[project.scripts]
-pyobjcryst = "pyobjcryst.app:main"
-
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements/pip.txt"]}