Switch to furo theme

[nx10]

Description

Uses the furo theme for sphinx.

furo is a modern theme for sphinx that has table of contents, search, auto light and dark mode, and more built in. The documentation was very hard to read on wide monitors before.

This is the theme nilearn switched to recently

Screenshots

Checklist

• [x] My pull request has a descriptive title (not a vague title like Update index.md).
• [x] My pull request targets the source branch of the repository.
• [x] My commit messages follow best practices.
• [x] My code follows the established code style of the repository.
• [x] I tried letting the CI build this branch on a fork or built the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

[nx10]

There might be some formatting errors in some of the pages, and more sphinx plugins we dont need anymore as they are now built in, hence WIP PR.

[anibalsolon]

Art in its purest form

[nx10]

I thought a bit about how to retain interactivity inside SVGs while still being able to scale and expand them:

This includes the SVG directly inside the html file and adds a [Open image] button under it to expand it. Its also scoped inside a container so we can scope the CSS directive for scaling (without affecting any other SVGs):

.. container:: svg-flowchart

    .. raw:: html
        :file: ../_static/flowcharts/CI-flow.svg

    `Open image <../_static/flowcharts/CI-flow.svg>`_

Ubuntu does not want to record my cursor, but this is me first clicking directly on each link embedded in the SVG and then on [open image]:

Screencast from 06.02.2023 15:53:19.webm

If that is acceptable for you I will update the contrib documentation.

[shnizzedy]

I thought a bit about how to retain interactivity inside SVGs while still being able to scale and expand them:

This includes the SVG directly inside the html file and adds a [Open image] button under it to expand it. Its also scoped inside a container so we can scope the CSS directive for scaling (without affecting any other SVGs)

[…]

If that is acceptable for you I will update the contrib documentation.

I like it!

[nx10]

Citations

and references

look ok to me.

Edit: Compared to this page: https://fcp-indi.github.io/docs/latest/user/quick

[nx10]

I suspect a lot in docs/_sources/_static can be deleted. The requirements.txt also fixes a couple of packages to very specific version. Hard to tell what the reasoning was + if these are still needed.

Edit: Also do we really need torch for building the docs?

[shnizzedy]

Citations […] and references […] look ok to me.

Edit: Compared to this page: https://fcp-indi.github.io/docs/latest/user/quick

The references are still hardcoded in https://github.com/FCP-INDI/fcp-indi.github.io/blob/58d221ae59fcd67994df8af95f8b42242cfbef67/docs/_sources/user/quick.rst#L76-L122 as opposed to SSOT'd from references.bib like https://github.com/FCP-INDI/fcp-indi.github.io/blob/58d221ae59fcd67994df8af95f8b42242cfbef67/docs/_sources/user/tse.rst#L40-L43, but they also look fine in the new theme:

[shnizzedy]

I suspect a lot in docs/_sources/_static can be deleted. The requirements.txt also fixes a couple of packages to very specific version. Hard to tell what the reasoning was + if these are still needed.

Edit: Also do we really need torch for building the docs?

I think these housekeeping things should be (a) separate PR(s) from this one

[nx10]

CI seems to build it correctly: https://nx10.github.io/fcp-indi.github.io/docs/nightly/

[shnizzedy]

Thanks for humoring all my change requests and for updating our theme. This is a small change and big improvement