0
|
1 ===================
|
|
2 General information
|
|
3 ===================
|
|
4
|
|
5 Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM.
|
|
6
|
|
7 General information about Orthanc can be found on its official
|
|
8 Website: http://www.orthanc-server.com/
|
|
9
|
|
10 This repository contains the source code of the Orthanc Book,
|
|
11 which documents how Orthanc can be used.
|
|
12
|
|
13
|
|
14 =====
|
|
15 Setup
|
|
16 =====
|
|
17
|
|
18 To build the Orthanc Book from sources, you need to install Sphinx
|
|
19 (http://www.sphinx-doc.org/), the Python Documentation Generator.
|
|
20
|
|
21
|
|
22 Installing Sphinx under Ubuntu 14.04 LTS:
|
|
23 -----------------------------------------
|
|
24
|
|
25 # sudo pip install sphinx sphinx_bootstrap_theme
|
|
26
|
|
27
|
|
28 ============================
|
|
29 Generating the documentation
|
|
30 ============================
|
|
31
|
|
32 Under Linux
|
|
33 -----------
|
|
34
|
|
35 # cd ./Sphinx
|
|
36 # make html
|
|
37
|
|
38 The HTML documentation will be available in the folder
|
|
39 "./build/html". You can for instance open it using Mozilla Firefox as
|
|
40 follows:
|
|
41
|
|
42 # firefox ./build/html/index.html
|