Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Make the documentation build be permissive with warnings #66

Merged
merged 3 commits into from
Dec 10, 2024
Merged

ENH: Make the documentation build be permissive with warnings #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b7aaa5
DOC: Remove unnecessary indentation in package TOC entry
jhlegarreta Dec 10, 2024
399e5a8
DOC: Miscellaneous style improvements to documentation index file
jhlegarreta Dec 10, 2024
c70f067
ENH: Make the documentation build be permissive with warnings
jhlegarreta Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/doc_build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ jobs:

- name: Build docs
run: |
make -C doc/ SPHINXOPTS="-W -v" BUILDDIR="$HOME/docs" OUTDIR="$HOME/html" html
make -C doc/ SPHINXOPTS="-v" BUILDDIR="$HOME/docs" OUTDIR="$HOME/html" html
11 changes: 2 additions & 9 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.

Welcome to WMQL's documentation!
=========================================
================================

The White Matter Query Language (WMQL) is a technique to formally describe white matter tracts and to automatically extract them from diffusion MRI volumes. This query language allows us to construct a dictionary of anatomical definitions describing white matter tracts. The definitions include adjacent gray and white matter regions, and rules for spatial relations. This enables the encoding of anatomical knowledge of the human brain white matter as well as the automated coherent labeling of white matter anatomy across subjects.

Expand All @@ -17,16 +17,10 @@ Click here for :ref:`example_script`

This software is published under the following :ref:`license`




.. toctree::
:maxdepth: 1

tract_querier



tract_querier

Indices and tables
==================
Expand All @@ -35,7 +29,6 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`


.. rubric:: Footnotes

.. [#f1] Self archived author version available for download `here <https://hal.inria.fr/hal-01247061/document>`_. The previously published conference article can be found here `"On Describing Human White Matter Anatomy: The White Matter Query Language", Wassermann et al., MICCAI 2013 <_static/WassermannMICCAI2013.pdf>`_.
Loading