Douglas Neuroinformatics Platform Documentation

This repository contains documentation for the Douglas Neuroinformatics Platform, including guidance on getting started, using the system, research methods, available services, and getting help. The docs can be found here: https://docs.douglasneuroinformatics.ca

To build locally

Follow these steps.

1. uv venv
2. cd docs
3. uv pip install -r requirements.txt
4. uv run make html
5. open _build/html/index.html

To make changes, edit the markdown files. If you have done a major refactor (renaming files or directory structures), you can use make clean html to create a fresh build directory for local testing.

Also check out

• MyST docs
• SPHINX docs

Translations (French)

English markdown files are the source. French translations use the standard Sphinx gettext workflow: each page has a matching .po file under docs/locales/fr/LC_MESSAGES/ (e.g. docs/available_services/chatdnp.md -> docs/locales/fr/LC_MESSAGES/available_services/chatdnp.po). Any string that has no translation falls back to English, so pages can be translated one at a time.

1. cd docs
2. pip install sphinx-intl
3. Extract the English strings: make gettext
4. Create or update the French .po files: sphinx-intl update -p _build/gettext -l fr.
5. Fill in the msgstr "" entries in the .po file. Remove any #, fuzzy flag once a string is checked.
6. Build both languages side by side:
   • sphinx-build -b html . _build/html/en
   • sphinx-build -b html -D language=fr . _build/html/fr
7. Open docs/_build/html/en/index.html and use the Français / English link at the bottom of the sidebar menu to switch languages.

When the English text of a page changes, re-run steps 3 and 4. Changed strings are marked #, fuzzy and show in English until the translation is reviewed.

Switching languages

The Français / English link in the sidebar (docs/_templates/layout.html) swaps the /en/ or /fr/ part of the current page's URL, so it opens the same page in the other language. It matches the Read the Docs URL layout (/en/latest/... and /fr/latest/...) and the local _build/html/en and _build/html/fr layout above. The link is hidden when the URL has no language part (e.g. a plain make html build).

On Read the Docs, French is published as a separate translation project (language fr) that points to this same repository and is linked to the main project under Admin > Translations. Read the Docs then also lists both languages in its flyout menu.

Contributing

If you want to contribute your expertise to this documentation, the best place to start would be to create a new issue and describe the content you plan on adding. This will allow other contributors to discuss with you and is a good way to check if someone else is already working on a similar idea that you can collaborate on.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

isabelbacellar 🤔 👀	Gabriel A. Devenyi 🤔 🖋 📖 📆 ⚠️ 👀	Sebastian Urchs 🤔 🖋 📖 📆	Jeremie Fouquet 🖋 📖	LuceroGG 📓 🤔	Swapna 📓 🐛 🤔	raihaan 🤔
Thomas Beaudry 📖 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!