Skip to content

Commit e1d072c

Browse files
committed
setting up docs
1 parent 1700f7a commit e1d072c

File tree

2 files changed

+3
-22
lines changed

2 files changed

+3
-22
lines changed

README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,6 @@ A separate installation of FSL is required to use this package.
4848
Please review the FSL [installation instructions][fsl-install]
4949
and [licensing details][fsl-license].
5050

51-
## Installation
52-
53-
```console
54-
pip install pydra-fsl
55-
```
56-
57-
A separate installation of FreeSurfer is required to use this package.
58-
Please review the following [instructions][fsl-install]
59-
and [licensing details][fsl-license].
6051

6152
## Automatic Conversion
6253

@@ -177,8 +168,6 @@ generate sample data for them, should be defined in `related-packages/fileformat
177168
and `related-packages/fileformats-extras`, respectively.
178169

179170

180-
181-
182171
## License
183172

184173
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]
203192

204193
[fsl-license]: https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Licence
205194

206-
[hatch]: https://hatch.pypa.io/
207-
208195
[license]: https://spdx.org/licenses/Apache-2.0.html
209196

210197
[status-docs-badge]: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat

docs/source/conf.py

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,15 @@
33
# For the full list of built-in configuration values, see the documentation:
44
# https://www.sphinx-doc.org/en/master/usage/configuration.html
55

6-
import sys
7-
from pathlib import Path
8-
9-
from sphinx_pyproject import SphinxConfig
10-
11-
config = SphinxConfig(globalns=globals())
12-
sys.path.insert(0, str(Path.cwd().parent / "src"))
6+
from pydra.tasks.fsl import __version__ # noqa
137

148
# -- Project information -----------------------------------------------------
159
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1610

17-
project = config.name
11+
project = "pydra-fsl"
1812
author = "Pydra Development Team"
1913
copyright = f"2022-2023, {author}"
20-
release = config.version
14+
release = __version__
2115

2216
# -- General configuration ---------------------------------------------------
2317
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

0 commit comments

Comments
 (0)