nipreps / qkay

Manager for the quality assessment of large neuroimaging studies
Apache License 2.0
4 stars 3 forks source link

DOCS: Add documentation #34

Open esavary opened 5 months ago

esavary commented 5 months ago

To preview the rendering, run the following command: sphinx-build -M html docs/source path-output

closes #19

oesteban commented 4 months ago

I was just getting an idea of the roadmap and looking at issues and PRs. Unfortunately, I didn't have time for more.

On Mon, May 13, 2024, 22:47 esavary @.***> wrote:

@.**** commented on this pull request.

In docs/source/conf.py https://github.com/nipreps/qkay/pull/34#discussion_r1599062186:

+ +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'qkay' +copyright = '2024, esavary'

Yes, thanks for catching that. Sorry, my GitHub handle was added when I generated the template with Sphinx. Since you've started a review, do you have any additional comments, or is the rest ready to merge?

— Reply to this email directly, view it on GitHub https://github.com/nipreps/qkay/pull/34#discussion_r1599062186, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAESDRXCP4JROXAOYCYYLFLZCERGNAVCNFSM6AAAAABHI6Y2R6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDANJTG44TONZZGA . You are receiving this because you commented.Message ID: @.***>