Skip to content

RFC: Do we want versioned docs? And do we want to maintain them ourselves? #284

Open
@effigies

Description

@effigies

I can't remember if we moved from readthedocs or just started on gh-pages, but we now have versioned docs at https://nipreps.org/smriprep using an unmaintained Sphinx plugin called sphinxcontrib-versioning. I see niworkflows was moved away to some custom code (nipreps/niworkflows#656). It's unclear to me how much advantage we derive from maintaining old versions, and even less building the code ourselves to do it when readthedocs exists.

I see four options for sMRIPrep in rough order of preference:

  1. Move (back?) to ReadTheDocs and use normal Sphinx
  2. Drop versioning altogether and just push a single version to gh-pages
  3. Move to (and maintain) GitHub actions custom code
  4. Maintain a fork of sphinxcontrib-versioning

I think 4 is a bad choice but possibly the quickest path forward in the short term (we're already pinning @rwblair's fork).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions