|
0
|
1 General information
|
|
|
2 ===================
|
|
|
3
|
|
268
|
4 Orthanc is a lightweight, RESTful Vendor Neutral Archive for
|
|
|
5 DICOM. General information about Orthanc can be found on its
|
|
|
6 [official Website](http://www.orthanc-server.com/).
|
|
0
|
7
|
|
268
|
8 This repository contains the source code of the
|
|
|
9 [Orthanc Book](http://book.orthanc-server.com/), that documents how
|
|
|
10 Orthanc can be used. It also contains the source code of the
|
|
|
11 documentation of the
|
|
|
12 [REST API of Orthanc](http://api.orthanc-server.com/). The continuous
|
|
|
13 integration server (CIS) of Orthanc watches this repository, and
|
|
|
14 automatically publishes modifications online.
|
|
0
|
15
|
|
|
16
|
|
268
|
17 Orthanc Book
|
|
|
18 ============
|
|
|
19
|
|
0
|
20 Setup
|
|
151
|
21 -----
|
|
|
22
|
|
268
|
23 To build the Orthanc Book from sources, you need to install
|
|
|
24 [Sphinx](http://www.sphinx-doc.org/), the Python Documentation
|
|
|
25 Generator.
|
|
0
|
26
|
|
151
|
27
|
|
|
28 ### Installing Sphinx under Ubuntu 14.04 LTS ###
|
|
|
29
|
|
|
30 # sudo pip install sphinx sphinx_bootstrap_theme
|
|
0
|
31
|
|
|
32
|
|
268
|
33 Generating the Book
|
|
|
34 -------------------
|
|
151
|
35
|
|
|
36 ### Under Linux ###
|
|
0
|
37
|
|
151
|
38 # cd ./Sphinx
|
|
|
39 # make html
|
|
|
40
|
|
|
41 The HTML documentation will be available in the folder
|
|
|
42 `./build/html`. You can for instance open it using Mozilla Firefox as
|
|
|
43 follows:
|
|
|
44
|
|
|
45 # firefox ./build/html/index.html
|
|
0
|
46
|
|
|
47
|
|
268
|
48 Contributing to the Book
|
|
|
49 ------------------------
|
|
0
|
50
|
|
268
|
51 * Make sure to understand the
|
|
|
52 [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText).
|
|
151
|
53 * Fork this repository onto your BitBucket account.
|
|
268
|
54 * Edit the content of the
|
|
|
55 [`./Sphinx/source/` folder](./Sphinx/source/).
|
|
|
56 * Generate locally the Orthanc Book (cf. above), and make sure it
|
|
|
57 displays properly on your computer.
|
|
|
58 * Submit a
|
|
|
59 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html)
|
|
|
60 for review by the Orthanc project.
|
|
|
61 * Once the pull request is reviewed and accepted, the continuous
|
|
|
62 integration server of the Orthanc project will automatically
|
|
|
63 publish the new version [online](http://book.orthanc-server.com/).
|
|
|
64
|
|
|
65
|
|
|
66
|
|
|
67 REST API of Orthanc
|
|
|
68 ===================
|
|
|
69
|
|
|
70 Setup
|
|
|
71 -----
|
|
|
72
|
|
|
73 The REST API of Orthanc is documented according to the
|
|
|
74 [OpenAPI specification and in the YAML format](https://en.wikipedia.org/wiki/OpenAPI_Specification).
|
|
|
75
|
|
|
76 The source code of the OpenAPI documentation can be found in the file
|
|
|
77 [./OpenAPI/orthanc-openapi.yaml](./OpenAPI/orthanc-openapi.yaml)
|
|
|
78 within this repository.
|
|
|
79
|
|
|
80 Contributing to the OpenAPI
|
|
|
81 ---------------------------
|
|
|
82
|
|
|
83 * Make sure to understand the
|
|
|
84 [OpenAPI YAML format](https://swagger.io/specification/).
|
|
|
85 * Fork this repository onto your BitBucket account.
|
|
|
86 * Edit the content of the
|
|
|
87 [`./OpenAPI/orthanc-openapi.yaml` file](./OpenAPI/orthanc-openapi.yaml).
|
|
|
88 * Submit a
|
|
|
89 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html)
|
|
|
90 for review by the Orthanc project.
|
|
|
91 * Once the pull request is reviewed and accepted, the continuous
|
|
|
92 integration server of the Orthanc project will automatically
|
|
|
93 publish the new version [online](http://api.orthanc-server.com/).
|
