From e1d072c6e664f0165a5d12c33ec20371d9f87327 Mon Sep 17 00:00:00 2001 From: Tom Close Date: Fri, 10 May 2024 15:41:12 +1000 Subject: [PATCH] setting up docs --- README.md | 13 ------------- docs/source/conf.py | 12 +++--------- 2 files changed, 3 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 26f2e6b..719435b 100644 --- a/README.md +++ b/README.md @@ -48,15 +48,6 @@ A separate installation of FSL is required to use this package. Please review the FSL [installation instructions][fsl-install] and [licensing details][fsl-license]. -## Installation - -```console -pip install pydra-fsl -``` - -A separate installation of FreeSurfer is required to use this package. -Please review the following [instructions][fsl-install] -and [licensing details][fsl-license]. ## Automatic Conversion @@ -177,8 +168,6 @@ generate sample data for them, should be defined in `related-packages/fileformat and `related-packages/fileformats-extras`, respectively. - - ## License This project is distributed under the terms of the [Apache License, Version 2.0][license]. @@ -203,8 +192,6 @@ This project is distributed under the terms of the [Apache License, Version 2.0] [fsl-license]: https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Licence -[hatch]: https://hatch.pypa.io/ - [license]: https://spdx.org/licenses/Apache-2.0.html [status-docs-badge]: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat diff --git a/docs/source/conf.py b/docs/source/conf.py index f57d121..ee9b39e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -3,21 +3,15 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -import sys -from pathlib import Path - -from sphinx_pyproject import SphinxConfig - -config = SphinxConfig(globalns=globals()) -sys.path.insert(0, str(Path.cwd().parent / "src")) +from pydra.tasks.fsl import __version__ # noqa # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = config.name +project = "pydra-fsl" author = "Pydra Development Team" copyright = f"2022-2023, {author}" -release = config.version +release = __version__ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration