The online documentation of Clinica is hosted on a server which is currently being moved to a different physical location.
Because of this, the documentation of Clinica won't be accessible online until early July 2024.
Solutions
Potential solutions for users:
📖 Reading the raw pages
The raw documentation pages (markdown files) can be directly browsed in the folder clinica/docs. Some IDE can potentially offer nice renderings.
🛠️ Building the docs locally
To build the docs locally:
Clone the clinica repo: git clone git@github.com:aramis-lab/clinica.git & cd clinica
[Optional but strongly recommended] Create and activate a virtual environment: conda create -n clinica-doc python=3.10 & conda activate clinica-doc
Run: make doc
The HTML pages will be created in a folder named site.
The server has been installed to its new location and is connected since Wednesday evening.
Online documentation is thus back sooner than expected, so closing this...
❗Online documentation not accessible
The online documentation of Clinica is hosted on a server which is currently being moved to a different physical location. Because of this, the documentation of Clinica won't be accessible online until early July 2024.
Solutions
Potential solutions for users:
📖 Reading the raw pages
The raw documentation pages (markdown files) can be directly browsed in the folder
clinica/docs
. Some IDE can potentially offer nice renderings.🛠️ Building the docs locally
To build the docs locally:
git clone git@github.com:aramis-lab/clinica.git & cd clinica
conda create -n clinica-doc python=3.10 & conda activate clinica-doc
make doc
The HTML pages will be created in a folder named
site
.