silx-kit / pyFAI

Fast Azimuthal Integration in Python
Other
105 stars 95 forks source link

Move to pydata sphinx theme #2017

Open kif opened 9 months ago

kif commented 9 months ago

Decision taken at the Doc-day ... See https://github.com/silx-kit/silx/pull/3994 for inspiration

kif commented 8 months ago

Not that trivial:

/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/detectors/_non_flat.py:docstring of pyFAI.detectors._non_flat.CylindricalDetector.get_pixel_corners:7: ERROR: Unexpected indentation.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/detectors/_common.py:docstring of pyFAI.detectors._common.Detector.get_pixel_corners:8: ERROR: Unexpected indentation.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/geometry/core.py:docstring of pyFAI.geometry.core.Geometry:9: WARNING: Include file '/users/kieffer/workspace-400/pyFAI/doc/source/mathematica/geometry.txt' not found or reading it failed
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/dialog/Detector3dDialog.py:docstring of pyFAI.gui.dialog.Detector3dDialog:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/dialog/IntegrationMethodDialog.py:docstring of pyFAI.gui.dialog.IntegrationMethodDialog:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/helper/RingExtractor.py:docstring of pyFAI.gui.helper.RingExtractor:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/model/AbstractModel.py:docstring of pyFAI.gui.model.AbstractModel:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/model/ImageModel.py:docstring of pyFAI.gui.model.ImageModel:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/model/ImageModel.py:docstring of pyFAI.gui.model.ImageModel:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/model/ListModel.py:docstring of pyFAI.gui.model.ListModel:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/tasks/AbstractCalibrationTask.py:docstring of pyFAI.gui.tasks.AbstractCalibrationTask:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/tasks/AbstractCalibrationTask.py:docstring of pyFAI.gui.tasks.AbstractCalibrationTask:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/tasks/AbstractCalibrationTask.py:docstring of pyFAI.gui.tasks.AbstractCalibrationTask:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/tasks/AbstractCalibrationTask.py:docstring of pyFAI.gui.tasks.AbstractCalibrationTask:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/tasks/GeometryTask.py:docstring of pyFAI.gui.tasks.GeometryTask:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/widgets/CalibrantSelector.py:docstring of pyFAI.gui.widgets.CalibrantSelector.CalibrantSelector:1: ERROR: Unknown interpreted text role "prop".
/users/kieffer/workspace-400/pyFAI/build/lib/python3.11/site-packages/pyFAI/gui/widgets/CalibrantSelector.py:docstring of pyFAI.gui.widgets.CalibrantSelector:1: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/api/resources/index.rst:5: WARNING: Title underline too short.

pyFAI.resources.__init__ module
----------------------------
/users/kieffer/workspace-400/pyFAI/doc/source/changelog.rst:106: WARNING: Bullet list ends without a blank line; unexpected unindent.
/users/kieffer/workspace-400/pyFAI/doc/source/conventions.rst:48: WARNING: Literal block ends without a blank line; unexpected unindent.
/users/kieffer/workspace-400/pyFAI/doc/source/man/diff_tomo.rst:77: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/man/pyFAI-diffmap.rst:10: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/man/pyFAI-diffmap.rst:91: WARNING: Inline emphasis start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Parallelization/Untitled.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Separation/Separate.ipynb:525: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Separation/Separate.ipynb:529: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Soleil/Soleil_Diffabs_Calibration_K6C.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Soleil/Soleil_Diffabs_Diffraction_Tomography.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/ThickDetector/Untitled.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Untitled.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Untitled-old.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Variance/Debug.ipynb:1: WARNING: Each notebook should have at least one section title
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Variance/Variance_reduction.ipynb:1: WARNING: Each notebook should have at least one section title
looking for now-outdated files... none found
pickling environment... done
checking consistency... /users/kieffer/workspace-400/pyFAI/doc/source/api/gui/dialog.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/api/gui/helper.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/api/gui/model.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/api/gui/tasks.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/api/gui/utils.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/api/gui/widgets.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/man/eiger-mask.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/man/pyFAI-diffmap.rst: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Parallelization/C2_Direct_chunk_read.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Parallelization/C3_Direct_chunk_read.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Parallelization/MultiGPU-lintaillefer.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Parallelization/Untitled.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Separation/peakfinder8/sortingPhotonEnergy.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/ThickDetector/Untitled.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Untitled.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Untitled-old.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Variance/Debug.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Variance/Validator.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/usage/tutorial/Variance/Variance_reduction.ipynb: WARNING: document isn't included in any toctree
/users/kieffer/workspace-400/pyFAI/doc/source/biblio.rst:41: WARNING: Citation [FabIO] is not referenced.
/users/kieffer/workspace-400/pyFAI/doc/source/biblio.rst:50: WARNING: Citation [FFTw] is not referenced.
/users/kieffer/workspace-400/pyFAI/doc/source/biblio.rst:74: WARNING: Citation [Dpdak] is not referenced.
done
preparing documents... done
writing output... [  0%] api/app/index                                                                                                                                                       
Extension error (pydata_sphinx_theme):
Handler <function update_and_remove_templates at 0x7fde2cc7c180> for event 'html-page-context' threw an exception (exception: version.html)