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

Fix Errors in Documentation Build #2406

Open
ashleymeigh2 opened this issue Nov 18, 2024 · 2 comments · May be fixed by #2409
Open

Fix Errors in Documentation Build #2406

ashleymeigh2 opened this issue Nov 18, 2024 · 2 comments · May be fixed by #2409

Comments

@ashleymeigh2
Copy link
Collaborator

There are warnings and errors in the documentation build process that need to be addressed. These issues may involve missing references, outdated links, or incorrect file paths in the documentation files. Resolving these errors will improve the documentation quality and ensure a smooth build process.

@MikeSullivan7
Copy link
Collaborator

Which warnings have been fixed by this PR?

I still get these following errors/warnings:

<unknown>:265: SyntaxWarning: invalid escape sequence '\s'ct.cil_recon
<unknown>:291: SyntaxWarning: invalid escape sequence '\m'
<unknown>:26: SyntaxWarning: invalid escape sequence '\i'
<unknown>:96: SyntaxWarning: invalid escape sequence '\s'
<unknown>:184: SyntaxWarning: invalid escape sequence '\s'
reading sources... [100%] user_guide/tutorials/quick_start
C:\Users\ddb29996\mantidimaging\mantidimaging\core\operations\flat_fielding\flat_fielding.py:docstring of mantidimaging.core.operations.flat_fielding.flat_fielding.FlatFieldFilter.filter_func:8: ERROR: Unexpected indentation.
C:\Users\ddb29996\mantidimaging\mantidimaging\core\operations\flat_fielding\flat_fielding.py:docstring of mantidimaging.core.operations.flat_fielding.flat_fielding.FlatFieldFilter.filter_func:9: WARNING: Block quote ends without a blank line; unexpected unindent.
C:\Users\ddb29996\mantidimaging\mantidimaging\core\operations\roi_normalisation\roi_normalisation.py:docstring of mantidimaging.core.operations.roi_normalisation.roi_normalisation.RoiNormalisationFilter.filter_func:10: ERROR: Unexpected indentation.
C:\Users\ddb29996\mantidimaging\mantidimaging\core\operations\roi_normalisation\roi_normalisation.py:docstring of mantidimaging.core.operations.roi_normalisation.roi_normalisation.RoiNormalisationFilter.filter_func:12: ERROR: Unexpected indentation.
C:\Users\ddb29996\mantidimaging\mantidimaging\core\operations\roi_normalisation\roi_normalisation.py:docstring of mantidimaging.core.operations.roi_normalisation.roi_normalisation.RoiNormalisationFilter.filter_func:13: WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: autodoc: failed to import module 'histogram_test' from module 'mantidimaging.core.utility'; the following exception was raised:
No module named 'mantidimaging.core.utility.histogram_test'
docstring of mantidimaging.gui.dialogs.async_task.model.AsyncTaskDialogModel.task_done:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.dialogs.async_task.presenter.AsyncTaskDialogPresenter.progress_updated:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.dialogs.cor_inspection.presenter.CORInspectionDialogPresenter.progress_updated:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.widgets.dataset_selector.view.DatasetSelectorWidgetView.dataset_selected_uuid:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.widgets.dataset_selector.view.DatasetSelectorWidgetView.datasets_updated:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.widgets.dataset_selector.view.DatasetSelectorWidgetView.stack_selected_uuid:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.widgets.zslider.zslider.ZSlider.valueChanged:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.live_viewer.model.ImageWatcher.image_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.live_viewer.model.ImageWatcher.recent_image_changed:1: WARNING: Inline emphasis start-string without end-string.
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\windows\main\model.py:docstring of mantidimaging.gui.windows.main.model.MainWindowModel.remove_container:4: ERROR: Unexpected indentation.
docstring of mantidimaging.gui.windows.main.view.MainWindowView.backend_message:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.main.view.MainWindowView.model_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.main.view.MainWindowView.stack_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.operations.view.FiltersWindowView.auto_update_triggered:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.operations.view.FiltersWindowView.filter_applied:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.recon.image_view.ReconImagesView.sigSliceIndexChanged:1: WARNING: Inline emphasis start-string without end-string.
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\windows\spectrum_viewer\model.py:docstring of mantidimaging.gui.windows.spectrum_viewer.model.SpectrumViewerWindowModel.get_stack_spectrum:4: ERROR: Unexpected indentation.
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\windows\spectrum_viewer\model.py:docstring of mantidimaging.gui.windows.spectrum_viewer.model.SpectrumViewerWindowModel.get_stack_spectrum:8: WARNING: Block quote ends without a blank line; unexpected unindent.
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\windows\spectrum_viewer\model.py:docstring of mantidimaging.gui.windows.spectrum_viewer.model.SpectrumViewerWindowModel.validate_bin_and_step_size:8: ERROR: Unexpected indentation.
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\windows\spectrum_viewer\model.py:docstring of mantidimaging.gui.windows.spectrum_viewer.model.SpectrumViewerWindowModel.validate_bin_and_step_size:11: WARNING: Block quote ends without a blank line; unexpected unindent.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumPlotWidget.range_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumROI.sig_colour_change:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumWidget.range_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumWidget.roiColorChangeRequested:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumWidget.roi_changed:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.spectrum_viewer.spectrum_widget.SpectrumWidget.roi_clicked:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.stack_visualiser.view.StackVisualiserView.roi_updated:1: WARNING: Inline emphasis start-string without end-string.
docstring of mantidimaging.gui.windows.wizard.view.WizardView.close_steps:1: WARNING: Inline emphasis start-string without end-string.
C:\Users\ddb29996\mantidimaging\docs\user_guide/explanations/operations/index.rst:4: WARNING: Duplicate explicit target name: "scipy documentation".
looking for now-outdated files... none found
pickling environment... done
checking consistency... C:\Users\ddb29996\mantidimaging\docs\api/mantidimaging.core.utility.histogram_test.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] user_guide/tutorials/quick_start
C:\Users\ddb29996\mantidimaging\mantidimaging\gui\widgets\mi_image_view\view.py:docstring of mantidimaging.gui.widgets.mi_image_view.view.MIImageView.setImage:42: WARNING: undefined label: 'apiref_config'
C:\Users\ddb29996\mantidimaging\docs\installation.rst:14: WARNING: undefined label: 'developer_guide'```

@ashleymeigh2
Copy link
Collaborator Author

I'm only fixing errors related to the docs. please ignore C:\Users\44770\PycharmProjects\mantidimaging\docs\user_guide/explanations/operations/index.rst:4: WARNING: Duplicate explicit target name: "scipy documentation".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants