Documenation build script - add check for missing docs files #250
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've noticed that it's very easy to add a new documentation page and then forget to include it in the
micro_sam/__init__.py
module docstring. This meanspdoc
can't find it, and it will never appear on the website.This PR:
micro_sam/__init__.py
docstring. It raises a RuntimeError if any missing files are found, with instructions on how to fix it..github/workflows/build_docs.yaml
script so that it uses the samebuild_docs.py
script to generate the documentation. Advantages: (i) we can use the same check for missing files automatically, and (ii) it's simpler to use the same process everywhereband.md
anddevelopment.md
to the docstring inmicro_sam/__init__.py
. Now,pdoc
will be able to find this content and include it on the websiteband.md
. By making the subsections have level 2 markdown headings, instead of just bold text, the different sections will appear in the left hand sidebar menu of the website, and people can click on them to go directly to that section.