Skip to content

Adding training plan proposal#142

Merged
khaledk2 merged 3 commits into
ome:mainfrom
khaledk2:train_plan
May 12, 2026
Merged

Adding training plan proposal#142
khaledk2 merged 3 commits into
ome:mainfrom
khaledk2:train_plan

Conversation

@khaledk2

Copy link
Copy Markdown
Collaborator

This PR introduces the training plan proposal.

@khaledk2
khaledk2 requested a review from pwalczysko May 12, 2026 11:05
Comment thread docs/training_plan/training_pln.rst Outdated
Comment thread docs/training_plan/training_pln.rst Outdated
Comment thread docs/training_plan/training_pln.rst Outdated

@pwalczysko pwalczysko left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some warnings on sphinx build, the toctree one seems to be very serious.

make clean html          
Removing everything under '_build'...
Running Sphinx v5.3.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 7 source files that are out of date
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [100%] user_guide/user_guide                                                                                              
/Users/pwalczysko/Work/omero_search_engine/docs/configuration/configuration_installation.rst:123: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/Users/pwalczysko/Work/omero_search_engine/docs/developer/developer.rst:2: WARNING: Title underline too short.

Developer documentation
=====================
/Users/pwalczysko/Work/omero_search_engine/docs/index.rst:6: WARNING: toctree contains reference to nonexisting document 'training_plan/training_plan'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/pwalczysko/Work/omero_search_engine/docs/training_plan/training_pln.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] user_guide/user_guide                                                                                               
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 4 warnings.

Additionally to ^^^, couple of minor suggestions

@pwalczysko

Copy link
Copy Markdown
Member

Indeed, when built locally, the training_plan is missing from the index page, so the toctree error must be fixed.

Screenshot 2026-05-12 at 12 28 55

khaledk2 and others added 2 commits May 12, 2026 12:48
Co-authored-by: pwalczysko <p.walczysko@dundee.ac.uk>
@khaledk2

Copy link
Copy Markdown
Collaborator Author

This was a typo in the file name; it has now been fixed, and it should work fine.

@khaledk2
khaledk2 merged commit 952f55c into ome:main May 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants