Researcher Facing Read the Docs

Contributor Notes

Accessibility

Color vision deficiency checker: https://www.toptal.com/designers/colorfilter/

Developer Notes

Build steps (not yet automated)

Make sure to build hardware tables using the following command.

python ci_pipeline/build_resource_tables.py --fabric hpc source/resources/data

Check URLs using the following. If the URLs are clean, there will be empty output.

python ci_pipeline/check_url.py

Images

• Use **/images to store images in each subfolder.
• Use .. figure:: ./images/<image_file> to reference images.
• All figure:: must have a descriptive :alt: text.
• Use maximally-compressed *.png file format for images.

Links

• External targets should be anonymous, not explicit. Single underscores are "explicit targets", double underscores are "anonymous targets". External links should be formatted as Link text `<URL>`__, note the double underscore.

Branding Guidance

• Brand main page: https://www.uab.edu/toolkit/branding
• Brand colors: https://www.uab.edu/toolkit/brand-basics/colors
• Copyright guidance: https://www.uab.edu/toolkit/trademarks-licensing/uab-trademarks

Known Issues

• Some inline languages add an <s> tag in html, leading to strikethroughs. This occurs for string literals in MATLAB and R.